x

Main chapters

  1. LimeSurvey Cloud vs LimeSurvey CE
  2. LimeSurvey Cloud - Quick start guide
  3. LimeSurvey CE - Installation
  4. How to design a good survey (Guide)
  5. Getting started
  6. LimeSurvey configuration
  7. Introduction - Surveys
  8. View survey settings
  9. View survey menu
  10. View survey structure
  11. Introduction - Questions
  12. Introduction - Question Groups
  13. Introduction - Surveys - Management
  14. Survey toolbar options
  15. Multilingual survey
  16. Quick start guide - ExpressionScript
  17. Advanced features
  18. General FAQ
  19. Troubleshooting
  20. Workarounds
  21. License
  22. Version change log
  23. Plugins - Advanced
 Actions

GetValidScreenFiles: Difference between revisions

From LimeSurvey Manual

DenisChenu (talk | contribs)
DenisChenu (talk | contribs)
mNo edit summary
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{FeatureStarting|3.13.0}}
{{FeatureStarting|3.13.0}}
{{Alert|This event is broken since LimeSurvey 5.5.}}


== Usage ==
== Usage ==
Line 20: Line 22:
     public function getPluginTwigPath()
     public function getPluginTwigPath()
     {
     {
         if (
         if(
             $this->getEvent()->get("type") != 'view' ||
             $this->getEvent()->get("type")!='view' ||
             ( $this->getEvent()->get("screen") && $this->getEvent()->get("screen") != "register" )
             ($this->getEvent()->get("screen") && $this->getEvent()->get("screen")!="register")
         ) {
         ){
             return;
             return;
         }
         }
         $this->getEvent()->append('remove', array("subviews/registration/register_form.twig"));
         if($this->getEvent()->get("screen")) {
            $this->getEvent()->append('remove', array("subviews/registration/register_form.twig"));
        }
         $this->getEvent()->append('add', array(
         $this->getEvent()->append('add', array(
             "subviews/registration/registerquick_form.twig",
             "subviews/registration/registerquick_form.twig",

Latest revision as of 17:18, 4 July 2023

 Hint: This features is available starting in version 3.13.0


  This event is broken since LimeSurvey 5.5.


Usage

This event allow plugin to add twig file inside the template edito

Input

  • type : the file type : view (twig) , css or js
  • screen : the screen currently edited (null mean all screen, when save : screen is not set)

Possible output

  • remove : array of file to be removed
  • add : array of file to be removed

Sample

    public function getPluginTwigPath()
    {
        if(
            $this->getEvent()->get("type")!='view' ||
            ($this->getEvent()->get("screen") && $this->getEvent()->get("screen")!="register")
        ){
            return;
        }
        if($this->getEvent()->get("screen")) {
            $this->getEvent()->append('remove', array("subviews/registration/register_form.twig"));
        }
        $this->getEvent()->append('add', array(
            "subviews/registration/registerquick_form.twig",
            "subviews/registration/registerquick_token_form.twig"
        ));
    }