SondagesPro / LS-reloadAnyResponse

Mirror of https://gitlab.com/SondagesPro/coreAndTools/reloadAnyResponse

reloadAnyResponse plugin for LimeSurvey.

Allow to reload any response with options

Installation

Via GIT

• Go to your LimeSurvey Directory
• Clone in plugins/addScriptToQuestion directory : git clone https://gitlab.com/SondagesPro/coreAndTools/reloadAnyResponse.git

Via ZIP dowload

• Get the file reloadAnyResponse.zip
• Extract : unzip reloadAnyResponse.zip
• Move the directory to plugins/ directory inside LimeSurvey

Usage and options

Existing options

All of this options exist globally (at plugin settings page) and by survey.

• Allow admin user to edit response with responseid : if an admin user load a survey with param srid : the reponse of the survey with this id are loaded and admin user can edit it.
• Allow participant with token to create or reload responses : With not anonymous survey ; allow user to load specific response. Particullary interseting with answer persistance to off.
• Create unique code automatically : unique code allow any user knowing this code (and the response id) to reload this response.
• Allow using unique code if exist : If unique code exist, allow any user knowing it to edit the answer. Parameter used for the access code is code. for example usage of link 1234?srid=1&code=accessode try to load the response id 1 on survey 1234 with unique access code accessode.
• Throw a 401 error if try to reload without rights. : When anybody try to access a reponse, rights are tested. If current user didn't have reponse editing rights according to plugin settings and survey settings : you can choose to send a 401 or to let LimeSurvey do the action in this case.
• Time for disable multiple access (in minutes) : since editing a response by 2 person at same time can replace current response done : a time for disabling mutiple access for all response done.

Only at global plugin settings

• Replace edit response in browse response interface : when an admin user edit a response via admin gui default link : the plugin lauch the survey like it was seen publicly.
• Delete the link of response when a response is deleted. : Delete the link with the unique acces code of each response when this one was deleted. default to no, because new response got an new number when survey is activated agaon. Remind : if you use import/export as VV, a new response can replace an old one.
• Delete the link of all responses of a survey when it's deactivated. : Delete the existing link when a survey is deactivated. Default to no : this allow to import form an old database.
• Delete the link of all responses of a survey when it's deleted : Delete whole response access code when a survey is deleted. Default to yes.

Usage as tool for other plugins

The plugin add 2 models for managing existing access code and the multiple access time. You can easily know if plugin exist and is activated with Yii::getPathOfAlias('reloadAnyResponse').

responseLink model

• Create or find a reponse $responseLink = \reloadAnyResponse\models\responseLink::setResponseLink($iSurvey,$iResponse,$sToken).
• Get a response url with the parameters : $responseLink->getStartUrl($absolute = true);

Sample usage

    // Get the response link with access code
    $responseLink = \reloadAnyResponse\models\responseLink::setResponseLink(1234,1);
    if($responseLink->hasErrors()) {
        throw new CHttpException(500, \CHtml::$responseLink->errorSummary($responseLink));
    }
    // redirect to this link
    Yii::app()->getController()->redirect($responseLink->getStartUrl());

surveySession model

• save a session time : \reloadAnyResponse\models\surveySession::saveSessionTime($iSurvey,$iResponse=null)
• find a current response id is currently edited : \reloadAnyResponse\models\surveySession::getIsUsed($iSurvey,$iResponse=null)

If $iResponse is null : get the current response id from $_SESSION. The plugin use this model in beforeSurveyPage event if Time for disable multiple access (in minutes) is not empty.

reloadResponse helper

• This allow to reload any response by another plugin.
• Warning no control‘s on right or token are done by this helper, you must control rights in your plugin
• Constructor need surveyid and reponse id and optionnal language
• Start a survey with startSurvey function. Parameters was
  • $step The step where to start survey, null get the default from response, false start at 1st page.
  • $resetSubmit reset the submit date, by default reset if needed (Allow edit after completion is disabled).

Sample usage in beforeSurveyPage for example.

    $reloadReponse = new \reloadAnyResponse\helpers\reloadResponse($surveyId, $srid);
    $reloadReponse->startSurvey($step);

Contribute and issue

Contribution are welcome, for patch and issue : use gitlab.

Home page & Copyright

• HomePage https://extensions.sondages.pro/rubrique33
• Copyright © 2018-2019 Denis Chenu http://sondages.pro
• Licence : GNU Affero General Public License https://www.gnu.org/licenses/agpl-3.0.html