<?php
/***************************************************************************
- * Copyright (C) 2003-2007 Polytechnique.org *
+ * Copyright (C) 2003-2010 Polytechnique.org *
* http://opensource.polytechnique.org/ *
* *
* This program is free software; you can redistribute it and/or modify *
* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA *
***************************************************************************/
-// {{{ class Survey : root of any survey, contains all questions
-class Survey
+class Survey extends PlDBTableEntry implements SurveyQuestionContainer
{
- // {{{ static properties and functions, regarding survey modes and question types
- const MODE_ALL = 0;
- const MODE_XANON = 1;
- const MODE_XIDENT = 2;
- private static $longModes = array(self::MODE_ALL => "sondage ouvert à tout le monde, anonyme",
- self::MODE_XANON => "sondage restreint aux polytechniciens, anonyme",
- self::MODE_XIDENT => "sondage restreint aux polytechniciens, non anonyme");
- private static $shortModes = array(self::MODE_ALL => "tout le monde, anonyme",
- self::MODE_XANON => "polytechniciens, anonyme",
- self::MODE_XIDENT => "polytechniciens, non anonyme");
+ private $fetchQuestions = true;
+ public $questions = array();
- public static function getModes($long = true) {
- return ($long)? self::$longModes : self::$shortModes;
- }
-
- private static $types = array('text' => 'texte court',
- 'textarea' => 'texte long',
- 'num' => 'numérique',
- 'radio' => 'radio',
- 'checkbox' => 'checkbox',
- 'personal' => 'informations personnelles');
-
- public static function getTypes()
+ public function __construct()
{
- return self::$types;
+ parent::__construct('surveys');
+ $this->registerFieldValidator('shortname', 'ShortNameFieldValidator');
+ $this->registerFieldFormatter('voters', 'JSonFieldFormatter');
+ $this->registerFieldFormatter('viewers', 'JSonFieldFormatter');
}
- public static function isType($t)
+ protected function postFetch()
{
- return array_key_exists($t, self::$types);
- }
- // }}}
-
- // {{{ properties, constructor and basic methods
- private $id;
- private $title;
- private $description;
- private $end;
- private $mode;
- private $promos;
- private $valid;
- private $questions;
-
- public function __construct($args, $id = -1, $valid = false, $questions = null)
- {
- $this->update($args);
- $this->id = $id;
- $this->valid = $valid;
- $this->questions = ($questions == null)? array() : $questions;
- }
-
- public function update($args)
- {
- $this->title = $args['title'];
- $this->description = $args['description'];
- if (preg_match('#^\d{2}/\d{2}/\d{4}$#', $args['end'])) {
- $this->end = preg_replace('#^(\d{2})/(\d{2})/(\d{4})$#', '\3-\2-\1', $args['end']);
- } else {
- $this->end = (preg_match('#^\d{4}-\d{2}-\d{2}$#', $args['end']))? $args['end'] : '#';
- }
- $this->mode = $args['mode'];
- if ($args['mode'] == 0) {
- $args['promos'] = '';
- }
- $this->promos = ($args['promos'] == '' || preg_match('#^(\d{4}-?|(\d{4})?-\d{4})(,(\d{4}-?|(\d{4})?-\d{4}))*$#', $args['promos']))? $args['promos'] : '#';
- }
- // }}}
-
- // {{{ functions to access general information
- public function isMode($mode)
- {
- return ($this->mode == $mode);
- }
-
- public function checkPromo($promo)
- {
- $promos = explode('|', $this->promos);
- foreach ($promos as $p) {
- if ((preg_match('#^\d{4}$#', $p) && $p == $promo) ||
- (preg_match('#^\d{4}-$#', $p) && intval(substr($p, 0, 4)) <= $promo) ||
- (preg_match('#^-\d{4}$#', $p) && intval(substr($p, 1)) >= $promo) ||
- (preg_match('#^\d{4}-\d{4}$#', $p) && intval(substr($p, 0, 4)) <= $promo && intval(substr($p, 5)) >= $promo)) {
- return true;
- }
+ if (!$this->fetchQuestions) {
+ return true;
}
- return false;
- }
-
- public function isValid()
- {
- return $this->valid;
- }
-
- public function isEnded()
- {
- return (strtotime($this->end) - time() <= 0);
- }
-
- public function getTitle()
- {
- return $this->title;
- }
- // }}}
-
- // {{{ function toArray() : converts a question (or the whole survey) to array
- public function toArray($i = 'all')
- {
- if ($i != 'all' && $i != 'root') {
- $i = intval($i);
- if (array_key_exists($i, $this->questions)) {
- return $this->questions[$i]->toArray();
+ $selector = new SurveyQuestion($this);
+ $selector->sid = $this->id;
+
+ $stack = array();
+ foreach ($selector as $question) {
+ $question = $question->typedInstance();
+ if (is_null($question->parent)) {
+ $this->addQuestion($question);
} else {
- return null;
- }
- } else {
- $a = array('title' => $this->title,
- 'description' => $this->description,
- 'end' => $this->end,
- 'mode' => $this->mode,
- 'promos' => $this->promos,
- 'valid' => $this->valid,
- 'type' => 'root');
- if ($this->id != -1) {
- $a['id'] = $this->id;
- }
- if ($i == 'all' && count($this->questions) > 0) {
- $qArr = array();
- for ($k = 0; $k < count($this->questions); $k++) {
- $q = $this->questions[$k]->toArray();
- $q['id'] = $k;
- $qArr[$k] = $q;
+ $pos = count($stack) - 1;
+ while ($stack[$pos]->qid != $question->parent) {
+ --$pos;
+ array_pop($stack);
}
- $a['questions'] = $qArr;
+ Platal::assert(count($stack) > 0, "Invalid question structure");
+ Platal::assert($stack[$pos] instanceof SurveyQuestionContainer, "Invalid question type");
+ $stack[$pos]->addQuestion($question);
}
- return $a;
+ array_push($stack, $question);
}
+ return true;
}
- // }}}
- // {{{ function factory($type, $args) : builds a question according to the given type
- public function factory($t, $args)
+ protected function postSave()
{
- switch ($t) {
- case 'text':
- return new SurveyText($args);
- case 'textarea':
- return new SurveyTextarea($args);
- case 'num':
- return new SurveyNum($args);
- case 'radio':
- return new SurveyRadio($args);
- case 'checkbox':
- return new SurveyCheckbox($args);
- case 'personal':
- return new SurveyPersonal($args);
- default:
- return null;
+ $questions = array();
+ $selector = new SurveyQuestion($this);
+ $selector->sid = $this->id;
+ $selector->delete();
+
+ $this->reassignQuestionIds();
+ foreach ($this->questions as $question) {
+ $question->sid = $this->id;
+ $question->insert();
}
}
- // }}}
- // {{{ questions manipulation functions
- public function addQuestion($i, $c)
+ public function addQuestion(SurveyQuestion $question, $pos = null)
{
- if ($this->valid || $i > count($this->questions)) {
- return false;
+ $question->parent = null;
+ if (is_null($pos)) {
+ $this->questions[] = $question;
} else {
- array_splice($this->questions, $i, 0, array($c));
- return true;
+ array_splice($this->questions, $pos, 0, $question);
}
}
- public function delQuestion($i)
+ public function newQuestion($type, $pos = null)
{
- if ($this->valid || !array_key_exists($i, $this->questions)) {
- return false;
- } else {
- array_splice($this->questions, $i, 1);
- return true;
- }
+ $question = SurveyQuestion::instanceForType($this, $type);
+ $this->addQuestion($question, $pos);
+ return $question;
}
- public function editQuestion($i, $a)
+ public function reassignQuestionIds()
{
- if ($i == 'root') {
- $this->update($a);
- } else {
- $i = intval($i);
- if ($this->valid ||!array_key_exists($i, $this->questions)) {
- return false;
+ $id = 0;
+ foreach ($this->questions as $question) {
+ $question->qid = $id;
+ if ($question instanceof SurveyQuestionContainer) {
+ $id = $question->reassignQuestionIds();
} else {
- $this->questions[$i]->update($a);
+ $id++;
}
}
- return true;
+ return $id;
}
- // }}}
- // {{{ function checkSyntax() : checks syntax of the questions (currently the root only) before storing the survey in database
- private static $errorMessages = array(
- "dateformat" => "la date de fin de sondage est mal formattée : elle doit respecter la syntaxe dd/mm/aaaa",
- "datepassed" => "la date de fin de sondage est déjà dépassée : vous devez préciser une date future",
- "promoformat" => "les restrictions à certaines promotions sont mal formattées"
- );
-
- public function checkSyntax()
+ public function export()
{
- $rArr = array();
- if (!preg_match('#^\d{4}-\d{2}-\d{2}$#', $this->end)) {
- $rArr[] = array('question' => 'root', 'error' => self::$errorMessages["dateformat"]);
- } else {
- // checks that the end date given is not already passed
- // (unless the survey has already been validated : an admin can have a validated survey expired)
- if (!$this->valid && $this->isEnded()) {
- $rArr[] = array('question' => 'root', 'error' => self::$errorMessages["datepassed"]);
- }
- }
- if ($this->promos != '' && !preg_match('#^(\d{4}-?|(\d{4})?-\d{4})(,(\d{4}-?|(\d{4})?-\d{4}))*$#', $this->promos)) {
- $rArr[] = array('question' => 'root', 'error' => self::$errorMessages["promoformat"]);
+ $export = parent::export();
+ $export['questions'] = array();
+ foreach ($this->questions as $question) {
+ $export['questions'][] = $question->export();
}
- return (empty($rArr))? null : $rArr;
+ return $export;
}
- // }}}
- // {{{ functions that manipulates surveys in database
- // {{{ static function retrieveList() : gets the list of available survey (current, old and not validated surveys)
- public static function retrieveList($type, $tpl = true)
+ public function canSee(User $user)
{
- switch ($type) {
- case 'w':
- case 'waiting' :
- $where = 'valid=0';
- break;
- case 'c':
- case 'current':
- $where = 'valid=1 AND end > NOW()';
- break;
- case 'o':
- case 'old':
- $where = 'valid=1 AND end <= NOW()';
- break;
- default:
- return null;
- }
- $sql = 'SELECT id, title, end, mode
- FROM survey_surveys
- WHERE '.$where.';';
- if ($tpl) {
- return XDB::iterator($sql);
- } else {
- return XDB::iterRow($sql);
+ if ($this->uid == $user->id() || $user->hasFlag('admin')) {
+ return true;
}
+ return false;
}
- // }}}
- // {{{ static function retrieveSurvey() : gets a survey in database (and unserialize the survey object structure)
- public static function retrieveSurvey($sid)
+ public static function get($name, $fetchQuestions = true)
{
- $sql = 'SELECT questions, title, description, end, mode, promos, valid
- FROM survey_surveys
- WHERE id={?}';
- $res = XDB::query($sql, $sid);
- $data = $res->fetchOneAssoc();
- if (is_null($data) || !is_array($data)) {
- return null;
+ if (is_array($name)) {
+ $name = $name[0];
}
- $survey = new Survey($data, $sid, (boolean) $data['valid'], unserialize($data['questions']));
- return $survey;
- }
- // }}}
-
- // {{{ static function retrieveSurveyInfo() : gets information about a survey (title, description, end date, restrictions) but does not unserialize the survey object structure
- public static function retrieveSurveyInfo($sid)
- {
- $sql = 'SELECT title, description, end, mode, promos, valid
- FROM survey_surveys
- WHERE id={?}';
- $res = XDB::query($sql, $sid);
- return $res->fetchOneAssoc();
- }
- // }}}
-
- // {{{ function proposeSurvey() : stores a proposition of survey in database (before validation)
- public function proposeSurvey()
- {
- $sql = 'INSERT INTO survey_surveys
- SET questions={?},
- title={?},
- description={?},
- author_id={?},
- end={?},
- mode={?},
- promos={?},
- valid=0;';
- return XDB::execute($sql, serialize($this->questions), $this->title, $this->description, S::v('uid'), $this->end, $this->mode, $this->promos);
- }
- // }}}
-
- // {{{ function updateSurvey() : updates a survey in database (before validation)
- public function updateSurvey()
- {
- if ($this->id == -1) {
- return false;
+ $survey = new Survey();
+ $survey->fetchQuestions = $fetchQuestions;
+ if (can_convert_to_integer($name)) {
+ $survey->id = $name;
+ } else {
+ $survey->shortname = $name;
}
- $sql = 'UPDATE survey_surveys
- SET questions={?},
- title={?},
- description={?},
- end={?},
- mode={?},
- promos={?}
- WHERE id={?};';
- return XDB::execute($sql, serialize($this->questions), $this->title, $this->description, $this->end, $this->mode, $this->promos, $this->id);
- }
- // }}}
-
- // {{{ static function validateSurvey() : validates a survey
- public static function validateSurvey($sid)
- {
- $sql = 'UPDATE survey_surveys
- SET valid=1
- WHERE id={?};';
- return XDB::execute($sql, $sid);
- }
- // }}}
-
- // {{{ functions vote() and hasVoted() : handles vote to a survey
- public function vote($uid, $args)
- {
- XDB::execute('INSERT INTO survey_votes
- SET survey_id={?}, user_id={?};', $this->id, $uid); // notes the user as having voted
- $vid = XDB::insertId();
- for ($i = 0; $i < count($this->questions); $i++) {
- $ans = $this->questions[$i]->checkAnswer($args[$i]);
- if ($ans != "") {
- XDB::execute('INSERT INTO survey_answers
- SET vote_id = {?},
- question_id = {?},
- answer = {?}', $vid, $i, $ans);
- }
+ if (!$survey->fetch()) {
+ return null;
}
+ return $survey;
}
- public function hasVoted($uid)
- {
- $res = XDB::query('SELECT id
- FROM survey_votes
- WHERE survey_id={?} AND user_id={?};', $this->id, $uid); // checks whether the user has already voted
- return ($res->numRows() != 0);
- }
- // }}}
-
- // {{{ static function deleteSurvey() : deletes a survey (and all its votes)
- public static function deleteSurvey($sid)
- {
- $sql = 'DELETE s.*, v.*, a.*
- FROM survey_surveys AS s
- LEFT JOIN survey_votes AS v
- ON v.survey_id=s.id
- LEFT JOIN survey_answers AS a
- ON a.vote_id=v.id
- WHERE s.id={?};';
- return XDB::execute($sql, $sid);
- }
- // }}}
-
- // {{{ static function purgeVotes() : clears all votes concerning a survey (I'm not sure whether it's really useful)
- public static function purgeVotes($sid)
+ public static function iterActive()
{
- $sql = 'DELETE v.*, a.*
- FROM survey_votes AS v
- LEFT JOIN survey_answers AS a
- ON a.vote_id=v.id
- WHERE v.survey_id={?};';
- return XDB::execute($sql, $sid);
+ $survey = new Survey();
+ $survey->fetchQuestions = false;
+ return $survey->iterateOnCondition('begin <= CURDATE() AND end >= CURDATE()
+ AND FIND_IN_SET(\'validated\', flags)');
}
- // }}}
-
- // }}}
}
-// }}}
-// {{{ abstract class SurveyQuestion
-abstract class SurveyQuestion
+class ShortNameFieldValidator implements PlDBTableFieldValidator
{
- // {{{ common properties, constructor, and basic methods
- private $question;
- private $comment;
-
- public function __construct($args)
- {
- $this->update($args);
- }
-
- public function update($a)
- {
- $this->question = $a['question'];
- $this->comment = $a['comment'];
- }
-
- abstract protected function getQuestionType();
- // }}}
-
- // {{{ function toArray() : converts to array
- public function toArray()
+ public function __construct(PlDBTableField $field, $value)
{
- return array('type' => $this->getQuestionType(), 'question' => $this->question, 'comment' => $this->comment);
- }
- // }}}
-
- // {{{ function checkSyntax() : checks question elements (before storing into database), not currently needed (with new structure)
- protected function checkSyntax()
- {
- return null;
- }
- // }}}
-
- // {{{ function checkAnswer : returns a correctly formatted answer (or nothing empty string if error)
- public function checkAnswer($ans)
- {
- return "";
+ if (can_convert_to_integer($value) || !preg_match('/^[a-z0-9]+[-_\.a-z0-9]*[a-z0-9]+$/i', $value)) {
+ throw new PlDBBadValueException($value, $field,
+ 'The shortname can only contain alphanumerical caracters, dashes, underscores and dots');
+ }
}
- // }}}
-
- // {{{ function resultArray() : statistics on the results of the survey
- //abstract protected function resultArray($sid, $where);
- // }}}
}
-// }}}
-// {{{ abstract class SurveySimple extends SurveyQuestion : "opened" questions
-abstract class SurveySimple extends SurveyQuestion
+interface SurveyQuestionContainer
{
- public function checkAnswer($ans)
- {
- return $ans;
- }
+ public function addQuestion(SurveyQuestion $question, $pos = null);
+ public function newQuestion($type, $pos = null);
+ public function reassignQuestionIds();
}
-// {{{ class SurveyText extends SurveySimple : simple text field, allowing a few words
-class SurveyText extends SurveySimple
+class SurveyQuestion extends PlDBTableEntry
{
- public function getQuestionType()
- {
- return "text";
- }
-}
-// }}}
+ protected $survey;
+ protected $parentQuestion;
-// {{{ class SurveyTextarea extends SurveySimple : textarea field, allowing longer comments
-class SurveyTextarea extends SurveySimple
-{
- public function getQuestionType()
+ public function __construct(Survey $survey)
{
- return "textarea";
+ parent::__construct('survey_questions');
+ $this->registerFieldFormatter('parameters', 'JSonFieldFormatter');
+ $this->survey = $survey;
}
-}
-// }}}
-// {{{ class SurveyNum extends SurveySimple : allows numerical answers
-class SurveyNum extends SurveySimple
-{
- public function checkAnswer($ans)
+ public function typedInstance()
{
- return intval($ans);
+ $instance = self::instanceForType($this->survey, $this->type);
+ $instance->copy($this);
+ return $instance;
}
- protected function getQuestionType()
+ public static function instanceForType(Survey $survey, $type)
{
- return "num";
+ require_once dirname(__FILE__) . '/' . $type . '.inc.php';
+ $class = 'SurveyQuestion' . $type;
+ return new $class($survey);
}
}
-// }}}
-// }}}
-// {{{ abstract class SurveyList extends SurveyTreeable : restricted questions that allows only a list of possible answers
-abstract class SurveyList extends SurveyQuestion
+class SurveyQuestionGroup extends SurveyQuestion implements SurveyQuestionContainer
{
- protected $choices;
+ public $children = array();
- public function update($args)
+ public function __construct(Survey $survey)
{
- parent::update($args);
- $this->choices = explode('|', $args['options']);
+ parent::__construct($survey);
}
- public function toArray()
+ public function addQuestion(SurveyQuestion $question, $pos = null)
{
- $rArr = parent::toArray();
- $rArr['choices'] = $this->choices;
- $rArr['options'] = implode('|', $this->choices);
- return $rArr;
+ $question->parentQuestion = $this;
+ if (is_null($pos)) {
+ $this->children[] = $question;
+ } else {
+ array_splice($this->children, $pos, 0, $question);
+ }
}
-}
-
-// {{{ class SurveyRadio extends SurveyList : radio question, allows one answer among the list offered
-class SurveyRadio extends SurveyList
-{
- public function checkAnswer($ans)
+ public function newQuestion($type, $pos = null)
{
- return (array_key_exists($ans, $this->choices)) ? $ans : "";
+ $question = SurveyQuestion::instanceForType($this->survey, $type);
+ $this->addQuestion($question, $pos);
+ return $question;
}
- protected function getQuestionType()
+ public function reassignQuestionIds()
{
- return "radio";
- }
-}
-// }}}
-
-// {{{ class SurveyCheckbox extends SurveyList : checkbox question, allows any number of answers among the list offered
-class SurveyCheckbox extends SurveyList
-{
- public function checkAnswer($ans)
- {
- $rep = "|";
- foreach ($ans as $a) {
- if (array_key_exists($a,$this->choices)) {
- $rep .= $a . "|";
+ $id = $this->qid + 1;
+ foreach ($this->children as $question) {
+ $question->qid = $id;
+ if ($question instanceof SurveyQuestionContainer) {
+ $id = $question->reassignQuestionIds();
+ } else {
+ $id++;
}
}
- return $rep;
- }
-
- protected function getQuestionType()
- {
- return "checkbox";
- }
-}
-// }}}
-// }}}
-
-// {{{ class SurveyPersonal extends SurveyQuestion : allows easy and verified access to user's personal data (promotion, name...)
-// actually this type of question should be suppressed (non anonymous surveys are possible with survey modes)
-// and anyway it is not finished (checkAnswer implementation) : currently it does not store anything when a user votes
-class SurveyPersonal extends SurveyQuestion
-{
- private $perm;
-
- public function update($args)
- {
- $args['question'] = "Informations personnelles";
- parent::update($args);
- $this->perm['promo'] = isset($args['promo'])? 1 : 0;
- $this->perm['name'] = isset($args['name'])? 1 : 0;
+ return $id;
}
- public function checkAnswer($ans)
+ protected function postSave()
{
- if (intval($ans) == 1) {
- // requete mysql qvb
- return "";
- } else {
- return "";
+ foreach ($this->children as $question) {
+ $question->sid = $this->sid;
+ $question->parent = $this->qid;
+ $question->insert();
}
}
- protected function getQuestionType()
+ public function export()
{
- return "personal";
- }
-
- public function toArray()
- {
- $a = parent::toArray();
- $a['promo'] = $this->perm['promo'];
- $a['name'] = $this->perm['name'];
- return $a;
+ $export = parent::export();
+ $export['children'] = array();
+ foreach ($this->children as $child) {
+ $export['children'][] = $child->export();
+ }
+ return $export;
}
}
-// }}}
-// vim:set et sw=4 sts=4 sws=4 foldmethod=marker enc=utf-8:
+// vim:set et sw=4 sts=4 ts=4 foldmethod=marker enc=utf-8:
?>
projects / platal.git / blobdiff