Actions

GetValidScreenFiles: Difference between revisions

From LimeSurvey Manual

Line 20: Line 20:
     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",

Revision as of 10:40, 6 September 2020

 Hint: This features is available starting in version 3.13.0


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