Actions

GetValidScreenFiles: Difference between revisions

From LimeSurvey Manual

(→‎Input: when save : screen is not set)
mNo edit summary
 
(2 intermediate revisions 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 ($this->getEvent()->get("screen")=="register") {
         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('remove', array("subviews/registration/register_form.twig"));
            $this->getEvent()->append('add', array("subviews/registration/registerquick_form.twig","subviews/registration/registerquick_token_form.twig"));
         }
         }
        $this->getEvent()->append('add', array(
            "subviews/registration/registerquick_form.twig",
            "subviews/registration/registerquick_token_form.twig"
        ));
     }
     }
</syntaxhighlight>
</syntaxhighlight>

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"
        ));
    }