galette/lib/Galette/Core/PluginControllerTrait.php

   1 <?php
   2
   3 /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
   4
   5 /**
   6  * Translatable objects trait
   7  *
   8  * PHP version 5
   9  *
  10  * Copyright © 2020-2023 The Galette Team
  11  *
  12  * This file is part of Galette (http://galette.tuxfamily.org).
  13  *
  14  * Galette is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU General Public License as published by
  16  * the Free Software Foundation, either version 3 of the License, or
  17  * (at your option) any later version.
  18  *
  19  * Galette is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  *  GNU General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License
  25  * along with Galette. If not, see <http://www.gnu.org/licenses/>.
  26  *
  27  * @category  Core
  28  * @package   Galette
  29  *
  30  * @author    Johan Cwiklinski <johan@x-tnd.be>
  31  * @copyright 2020-2023 The Galette Team
  32  * @license   http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
  33  * @link      http://galette.tuxfamily.org
  34  * @since     2020-12-09
  35  */
  36
  37 namespace Galette\Core;
  38
  39 use DI\Attribute\Inject;
  40
  41 /**
  42  * Plugin controllers trait
  43  *
  44  * @category  Entity
  45  * @name      PluginControllerTrait
  46  * @package   Galette
  47  * @author    Johan Cwiklinski <johan@x-tnd.be>
  48  * @copyright 2020-2023 The Galette Team
  49  * @license   http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
  50  * @link      http://galette.tuxfamily.org
  51  * @since     2020-12-09
  52  */
  53
  54 trait PluginControllerTrait
  55 {
  56     /**
  57      * Something like:
  58      * #[Inject("Plugin Galette Name")]
  59      * @var array
  60      */
  61     protected $module_info;
  62
  63     /**
  64      * Get plugin module ID
  65      *
  66      * @return string
  67      */
  68     protected function getModuleId()
  69     {
  70         return $this->module_info['module_id'];
  71     }
  72
  73     /**
  74      * Get plugin module route namespace
  75      * @return string
  76      */
  77     protected function getModuleRoute()
  78     {
  79         return $this->module_info['module']['route'];
  80     }
  81
  82     /**
  83      * Get plugin template name for Twig
  84      *
  85      * @param $name Template name
  86      *
  87      * @return string
  88      */
  89     protected function getTemplate($name): string
  90     {
  91         return sprintf('@%s/%s.html.twig', $this->plugins->getClassName($this->getModuleId()), $name);
  92     }
  93 }