Not sure what you're trying to do here. The documentation is not entirely up to date with regard to plugins and 2.5.

You can check this plugin for examples: https://github.com/olleharstedt/MassAction/blob/master/MassAction.php#L933

Feel free to ask any questions.

Olle

I need a reliable way to create custom admin pages, that are wrapped inside the Limesurvey admin UI, in two flavors:

• Custom admin page with only the generic admin UI (no survey-specific UI)
• Custom admin page wrapped inside the survey-specific UI

See the attached screenshots.

P.S. I noticed that the TestPlugin.php is slightly wrong (echo instead of return). I attached the corrected TestPlugin2.php (browse to http://example.com/limesurvey/admin/pluginhelper?sa=sidebody&plugin=TestPlugin2&method=handleAdminRequest&surveyId=<id_of_an_existing_survey>).

P.P.S. I never got newDirectRequest to work. The attached plugin NewDirectRequestNotWorking.php illustrates the problem (see also issue 10645), so I used the plugin sidebody URLs instead.

<?php

/**
 * When accessing the path:
 *
 *  http://localhost/limesurvey/plugins/direct/?plugin=NewDirectRequestNotWorking&function=someEndpoint
 *
 * this plugin throws the error:
 *
 *  Alias "ext.Menu.MenuWidget" is invalid. Make sure it points to an existing PHP file and the file is readable.
 *  /framework/YiiBase.php(323)
 */
class NewDirectRequestNotWorking extends ls\pluginmanager\PluginBase {

  protected $storage = 'DbStorage';
  static protected $name = 'NewDirectRequestNotWorking';
  static protected $description = 'test';

  protected $settings = array();

  function init() {

    $this->subscribe( 'newDirectRequest' );
  }

  function newDirectRequest() {

    $event = $this->event;

    if ( $event->get( 'target' ) === __CLASS__ ) {
      $functionToCall = $event->get( 'function' );
      if ( method_exists( $this, $functionToCall ) ) {
        $content = $this->$functionToCall();
        $event->setContent( $this, $content );
      }
    }
  }

  function someEndpoint() {

    return '<strong>Some content wrapped inside the Limesurvey admin dashboard HTML wrapper.</strong>';
  }
}

The URL in Screenshot_2016-10-15_12-22-26.png (when surveyId is non-zero) only works, when I change the Survey_Common_Action.php call from

LimeExpressionManager::StartProcessingPage(false, Yii::app()->baseUrl)

to

LimeExpressionManager::StartProcessingPage(false).

Here are again the steps to reproduce:

• Install Limesurvey in a subdirectory (i.e. http://example.com/limesurvey/)
• Install the attached plugin TestPlugin2.php
• Login to Limesurvey admin
• Browse to http://example.com/limesurvey/admin/pluginhelper?sa=sidebody&plugin=TestPlugin2&method=handleAdminRequest&surveyId=<id_of_an_existing_survey>

PS : newDirectRequest don't have any helper. More for json, dieredirect in fact.

M%aybe add a new function in it for 'quickduplay message/content) to public : https://bugs.limesurvey.org/view.php?id=11801

Minimal layout for public survey.

I lik ethe idea to have different event for public part VS admin part.

Tony, your URL is wrong, I'm afraid. 2.5 uses a plugin helper, like this:

localhost/index.php/admin/pluginhelper?sa=sidebody&plugin=ExamplePlugin&method=actionIndex&surveyId=793951

Check this example plugin. BUT: You will have to pull the latest update from github, the necessary code is not released yet (will be soon).

A question: Which manual page did you first stumble upon when trying to implement plugin? If you give me a link I can update it.

Note that pluginhelper has two subactions (sa) you will use: "sidebody" and "fullpagewrapper". The "sidebody" subaction needs surveyId as a param:

    $href = Yii::app()->createUrl(
        'admin/pluginhelper',
        array(
            'sa' => 'sidebody',
            'plugin' => 'CintLink',
            'method' => 'actionIndex',
            'surveyId' => $surveyId
        )
    );

For "fullpagewrapper":

    $href = $this->api->createUrl(
        'admin/pluginhelper',
        array(
            'sa' => 'fullpagewrapper',
            'plugin' => $this->getName(),
            'method' => 'actionIndexGlobal'
        )
    );

Hope this helps!

Olle

Which part of my URL is incorrect? My URL
http://example.com/limesurvey/admin/pluginhelper?sa=sidebody&plugin=TestPlugin2&method=handleAdminRequest&surveyId=<id_of_an_existing_survey>
looks similar to your suggested URL
localhost/index.php/admin/pluginhelper?sa=sidebody&plugin=ExamplePlugin&method=actionIndex&surveyId=793951

The "fullpagewrapper" is a nice addition. It will be useful for me, so that I don't have to fake a full-page-wrapped custom admin page anymore with the "sidebody" subaction and no surveyId.

I checked the ExamplePlugin.php. Why is it using the newDirectRequest event? If I delete the newDirectRequest() and the init() methods from this plugin, the sidebody and fullpagewrapper URLs still work.

The bug mentioned in the ticket description still exists in 2.54.4. Have you tried to reproduce the steps?

Using a subdirectory installation of Limesurvey, this fails:

• Create a new survey (let's say the new survey ID is 1234)
• Log out
• Log in
• Browse to http://localhost/limesurvey/admin/pluginhelper?sa=sidebody&plugin=ExamplePlugin&method=actionIndex&surveyId=1234
• Result: Undefined index: LEMsid

This succeeds:

• Create a new survey (let's say the new survey ID is 1235)
• Log out
• Log in
• Browse to any survey edit view, say, http://localhost/limesurvey/admin/survey/sa/view/surveyid/235748
• Browse to http://localhost/limesurvey/admin/pluginhelper?sa=sidebody&plugin=ExamplePlugin&method=actionIndex&surveyId=1234
• Result: the sidebody URL does not result in an error. For some reason visiting a survey after login fixes the sidebody URLs.

(I can't seem to be able to edit the message, but the last URL should of course have the surveyId 1235.)

Great reproduction : LEMsid is related to expression manager start. But try reproducing issue with example plugin :

Go to the link just after login : no issue for me

BUT : seems more a core bug here : maybe LEM session is not set just before adding a survey. Not really needed in fact ....

OK, I can confirm that bug. Will have a look.

Fix committed to master branch: http://bugs.limesurvey.org/plugin.php?page=Source/view&id=21100

Version 2.55 released