Incorporate Expression Manager's Relevance and Validation Messages into Yii Branch
completed by: Gautam
LimeSurvey 2.0a (our latest development release) is based on the CodeIgniter framework. Unfortunately the CodeIgniter license is not compatible to the LimeSurvey GPL license so we need to port the LimeSurvey codebase to a new framework, Yii. We need your help to do this.
- Install a subversion client and download LimeSurvey 2.0a (that's the version still based on CodeIgniter) using subversion and install it by running http://<yourserver>/limesurvey/index.php/admin
- Do the same with the new LimeSurvey development branch based on Yii. There is no installer yet so just point the database configuration in /application/config.php to the database you created in step 1.
- Check out the functionality named in this task title in the CI version. If you have problems to find it please get in touch with us on IRC. #firstname.lastname@example.org
- Check out the source code and then port the functionality to Yii.
- Test the new functionality in the Yii version thoroughly.
- Submit a patch created with subversion and based on the YII branch to this task idea and wait for feedback.
Specific Steps for This Task
- Review the Expression Manager (EM) documentation and survey-building how-tos, and notes for developers.
- Note that the version of EM incorporated into 1.92 is more sophisticated than that in 2.0a.
- Download and install the LimeSurvey 1.92
- Try all of the tests - the path is localhost/limesurvey_dev/classes/eval/test/test.php
- For this task
- Many of the question types in qanda.php (qanda_helper.php), like do_array_5point(), display messages indicating whether the question is mandatory or has validation requirements (like min_num_answers > 5).
- Refactor those to use the tips from LimeExpressionManager::GetQuestionStatus($qid).
- Eliminate all database calls from qanda.php - all of the information they need to display questions, messages, etc. should be available from GetQuestionStatus($qid).
- Integrate these same tip messages into printable survey and data entry screens (so uses can see the relevance and validation logic even on the printed page).
- Ensure that the Yii port and 1.92 branch tests produce identical results.
- Good PHP knowledge
- Experience with a PHP MVC framework
- We want a straight port. Don't start to rewrite big portions of the code.
- If you can clean up the models it would be great but it is not necessary.
- It is important that you test your ported code thoroughly before you submit the patch. This will save you and us alot of time. It will take longer to accept your patch if you did not test.