galette/lib/Galette/Features/Translatable.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 © 2018-2021 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  Features
  28  * @package   Galette
  29  *
  30  * @author    Johan Cwiklinski <johan@x-tnd.be>
  31  * @copyright 2018-2021 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     Available since 0.9dev - 2017-05-26
  35  */
  36
  37 namespace Galette\Features;
  38
  39 /**
  40  * Translatable objects trait
  41  *
  42  * @category  Features
  43  * @name      Translatable
  44  * @package   Galette
  45  * @author    Johan Cwiklinski <johan@x-tnd.be>
  46  * @copyright 2018-2021 The Galette Team
  47  * @license   http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
  48  * @link      http://galette.tuxfamily.org
  49  * @since     Available since 0.9dev - 2017-05-26
  50  */
  51
  52 trait Translatable
  53 {
  54     protected $old_name;
  55     protected $name;
  56
  57     /**
  58      * Get field name
  59      *
  60      * @param boolean $translated Get translated or raw name
  61      *
  62      * @return String
  63      */
  64     public function getName($translated = true)
  65     {
  66         if (empty($this->name)) {
  67             return '';
  68         } elseif ($translated === true) {
  69             return _T(strip_tags($this->name));
  70         } else {
  71             return strip_tags($this->name);
  72         }
  73     }
  74 }