Forem: Bismark

LimeSurvey afterSurveyComplete event

Bismark — Wed, 01 Jun 2022 13:38:39 +0000

In my first article I created a simple plugin for LimeSurvey.
Now we want to add some text to the last page, when the user executes the survey.
LimeSurvey offers an event afterSurveyComplete.

All we have to to now is to subscribe to that event and implement an event handler method:

public function init()
{
    $this->subscribe('afterSurveyComplete');
}

A minimal implementation looks like this.

public function afterSurveyComplete()
{
    $event = $this->getEvent();
    $event->getContent($this)->addContent('Hello World');
}

For further processing, the event provides 2 parameters surveyId and responseId.


public function afterSurveyComplete()
{
    $event = $this->getEvent();

    $surveyId   = $event->get('surveyId');
    $responseId = $event->get('responseId');

    $response   = $this->pluginManager->getAPI()->getResponse($surveyId, $responseId);

    $myContent  = var_export($response, true);

    $event->getContent($this)->addContent($myContent);
}

That's it.
Bye!

LimeSurvey Plugin Settings

Bismark — Thu, 26 May 2022 11:51:49 +0000

In my last article I created a simple plugin for LimeSurvey,
that is used at the command line, which can be useful for cronjobs.

The next step could be some plugin settings. There are two types.

Global Plugin Settings

Global Plugin Settings are defined in a variable $settings

protected $settings = [
    'setting1' => [
        'type' => 'string',
        'label' => 'Setting One',
        'help' => 'This might be a useful hint',
        'default' => '' 
    ]
];

You can access this setting via:

var_dump($this->get('setting1'));

Survey Level Plugin Settings

In order to create some settings on survey level, you have to subscribe two events in your init() method.

public function init()
{
    /* @see https://manual.limesurvey.org/BeforeSurveySettings */
    $this->subscribe('beforeSurveySettings');
    /* @see https://manual.limesurvey.org/NewSurveySettings */
    $this->subscribe('newSurveySettings');
}

Next we define a field isActive of type boolean.
There are several types available. See some examples here:

public function beforeSurveySettings()
{
    $event = $this->event;
    $surveyId = $event->get('survey');

    $event->set("surveysettings.{$this->id}", [
        'name' => get_class($this),
        'settings' => [
            'isActive' => [
                'type' => 'boolean',
                'label' => 'enable plugin for this survey',
                'current' => $this->get('isActive', 'Survey', $surveyId, false),
                'help' => 'some useful hint'
            ]
        ]
     ]);
}

The following code is needed to save your survey settings:

public function newSurveySettings()
{
    $event = $this->event;
    foreach ($event->get('settings') as $name => $value) {
        $this->set($name, $value, 'Survey', $event->get('survey'));
    }
}

That's it.
Bye!

LimeSurvey HelloWorld Plugin

Bismark — Sat, 21 May 2022 09:23:50 +0000

The following code is needed to run a simple command on the command line within LimeSurvey.
Your folder structure under upload/plugins should be like this:

HelloWorld
- config.xml
- HelloWorld.php

<?xml version="1.0" encoding="UTF-8"?>
<config>
    <metadata>
        <name>HelloWorld</name>
        <type>plugin</type>
        <lastUpdate>2022-05-21</lastUpdate>
        <author>My Name</author>
        <authorEmail>My Email Address</authorEmail>
        <authorUrl>MY Homepage</authorUrl>
        <license></license>
        <version>1.0.0</version>
        <description><![CDATA[This Plugin does some magic on the command line]]></description>
    </metadata>

    <compatibility>
        <version>5.0</version>
        <version>4.0</version>
        <version>3.0</version>
    </compatibility>
</config>

class HelloWorld extends PluginBase
{
    protected $storage = 'LimeSurvey\PluginManager\DbStorage';
    static protected $description = 'HelloWorld';
    static protected $name = 'HelloWorld';

    /**
     * subscribe to all needed events
     * @see https://manual.limesurvey.org/Plugin_events
     */
    public function init()
    {
        /** @see https://manual.limesurvey.org/Direct_(command) */
        $this->subscribe('direct');
    }

    /**
     * php application/commands/console.php plugin --target=HelloWorld
     */
    public function direct()
    {
        $event = $this->getEvent();
        $target = $event->get('target');
        if ($target !== get_class($this)) return;

        echo 'HELLO WORLD' . PHP_EOL;
        exit;
    }

}

In LimeSurvey's PluginManager scan files, install and activate the plugin.
Then on the command line run:
php application/commands/console.php plugin --target=HelloWorld

And hopefully you can see: Hello World

Bye!