Actions

BeforeSurveyBarRender

From LimeSurvey Manual

Revision as of 12:38, 24 August 2016 by Olle (talk | contribs) (Created page with "{{FeatureStarting|2.51.0}} '''When''' This event is fired before the survey bar is rendered. '''Input''' The event receives the following information: {| ! Name !! Type...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
 Hint: This features is available starting in version 2.51.0


When

This event is fired before the survey bar is rendered.


Input

The event receives the following information:

Name Type Description
surveyId integer The id of the current survey


Possible output

The following information can be set in the event:

Name Type Description
menus Menu[] Array of Menu objects


Example

public function beforeSurveyBarRender()
{
    $event = $this->getEvent();
    $surveyId = $event->get('surveyId');

    $menu = new Menu(array(
        'label' => $this->gT('MyPlugin'),
        'iconClass' => 'fa fa-some-icon',
        'href' => $href
    ));

    $event->append('menus', array($menu));
}