Actions

Add new menu and view by a plugin: Difference between revisions

From LimeSurvey Manual

No edit summary
No edit summary
Line 38: Line 38:
7. The full Rewards.php  
7. The full Rewards.php  
[[File:Rewards.zip]]
[[File:Rewards1.zip]]




8. This is how the UI looks now.
8. This is how the UI looks now.
[[File:Screenshot_2014-08-21_01.34.05.png]]
[[File:Screenshot_2014-08-21_01.34.05.png]]

Revision as of 22:41, 20 August 2014

How to write a plugin that adds a menu to the admin menubar & when clicked renders some content

1. Create a new plugin. let us call it Rewards

2. register for events afterAdminMenuLoad and newDirectRequest in the constructor

3. implement the above methods methods in the new plugin class

4. In the method afterAdminMenuLoad, add a new menu item and link it to

   admin/plugins/direct?plugin=<plugin_name>&function=<plugin_action>
   e.g
   admin/plugins/direct?plugin=rewards&function=assignRewards

5. implement the method newDirectRequest

   public function newDirectRequest(){
       $event = $this->event;
       
       // you can get other params from the request object
       $request = $event->get('request');
       
       //get the function name to call and use the method call_user_func
       $functionToCall = $event->get('function');        
       $content = call_user_func(array($this,$functionToCall)); 
       //set the content on the event      
       $event->setContent($this, $content);        
   }


6. implement the method plugin_action, in our case it is assignRewards(). In this method currently i am just trying to return some dummy content, you can have sophisticated page rendered.

   public function assignRewards() {
        $content = "<h1> plugin content set succesfully </h1>";
        return $content;        
    }


7. The full Rewards.php File:Rewards1.zip


8. This is how the UI looks now.