Check headers

galette · Jan 24, 2024 · 1c4c5c6 · 1c4c5c6
1 parent bd8096a
commit 1c4c5c6
Show file tree

Hide file tree

Showing 13 changed files with 123 additions and 155 deletions.
diff --git a/.github/workflows/ci-linux.yml b/.github/workflows/ci-linux.yml
@@ -77,6 +77,11 @@ jobs:
           ../../vendor/bin/phpstan analyze --ansi --memory-limit=2G --no-interaction --no-progress
         if: matrix.php-versions == '8.1'
 
+      - name: Headers checks
+        run: |
+          cd galette-core/galette/plugins/plugin-maps
+          ../../vendor/bin/docheader --docheader=../../../.docheader check lib ./*.php
+
       - name: Install Node
         uses: actions/setup-node@v3
 

diff --git a/_config.inc.php b/_config.inc.php
@@ -1,15 +1,9 @@
 <?php
 
-/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
-
 /**
- * Configuration file for Maps plugin
- *
- * PHP version 5
- *
- * Copyright © 2012-2014 The Galette Team
+ * Copyright © 2003-2024 The Galette Team
  *
- * This file is part of Galette (http://galette.tuxfamily.org).
+ * This file is part of Galette (https://galette.eu).
  *
  * Galette is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -23,16 +17,6 @@
  *
  * You should have received a copy of the GNU General Public License
  * along with Galette. If not, see <http://www.gnu.org/licenses/>.
- *
- * @category  Plugins
- * @package   Galettemaps
- *
- * @author    Johan Cwiklinski <johan@x-tnd.be>
- * @copyright 2012-2014 The Galette Team
- * @license   http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
- * @version   SVN: $Id$
- * @link      http://galette.tuxfamily.org
- * @since     Available since 0.7.4dev - 2012-10-02
  */
 
 define('MAPS_PREFIX', 'maps_');
diff --git a/_define.php b/_define.php
@@ -1,13 +1,7 @@
 <?php
 
-/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
-
 /**
- * Configuration file for Maps plugin
- *
- * PHP version 5
- *
- * Copyright © 2012-2023 The Galette Team
+ * Copyright © 2003-2024 The Galette Team
  *
  * This file is part of Galette (https://galette.eu).
  *
@@ -23,15 +17,6 @@
  *
  * You should have received a copy of the GNU General Public License
  * along with Galette. If not, see <http://www.gnu.org/licenses/>.
- *
- * @category  Plugins
- * @package   GaletteMaps
- *
- * @author    Johan Cwiklinski <johan@x-tnd.be>
- * @copyright 2012-2023 The Galette Team
- * @license   http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
- * @version   SVN: $Id$
- * @link      https://galette.eu
  */
 
 $this->register(

diff --git a/_routes.php b/_routes.php
@@ -1,15 +1,9 @@
 <?php
 
-/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
-
 /**
- * Maps routes
- *
- * PHP version 5
- *
- * Copyright © 2015-2023 The Galette Team
+ * Copyright © 2003-2024 The Galette Team
  *
- * This file is part of Galette (http://galette.tuxfamily.org).
+ * This file is part of Galette (https://galette.eu).
  *
  * Galette is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -23,15 +17,6 @@
  *
  * You should have received a copy of the GNU General Public License
  * along with Galette. If not, see <http://www.gnu.org/licenses/>.
- *
- * @category  Plugins
- * @package   GaletteMaps
- *
- * @author    Johan Cwiklinski <johan@x-tnd.be>
- * @copyright 2015-2023 The Galette Team
- * @license   http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
- * @link      http://galette.tuxfamily.org
- * @since     0.9dev 2015-10-28
  */
 
 use GaletteMaps\Controllers\MapsController;

diff --git a/lib/GaletteMaps/Controllers/MapsController.php b/lib/GaletteMaps/Controllers/MapsController.php
@@ -1,15 +1,9 @@
 <?php
 
-/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
-
 /**
- * Galette main controller
- *
- * PHP version 5
- *
- * Copyright © 2020-2023 The Galette Team
+ * Copyright © 2003-2024 The Galette Team
  *
- * This file is part of Galette (http://galette.tuxfamily.org).
+ * This file is part of Galette (https://galette.eu).
  *
  * Galette is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -23,15 +17,6 @@
  *
  * You should have received a copy of the GNU General Public License
  * along with Galette. If not, see <http://www.gnu.org/licenses/>.
- *
- * @category  Entity
- * @package   GaletteMaps
- *
- * @author    Johan Cwiklinski <johan@x-tnd.be>
- * @copyright 2020-2023 The Galette Team
- * @license   http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
- * @link      http://galette.tuxfamily.org
- * @since     2020-12-07
  */
 
 namespace GaletteMaps\Controllers;
@@ -48,14 +33,7 @@
 /**
  * Galette maps controller
  *
- * @category  Controllers
- * @name      MapsController
- * @package   Galette
- * @author    Johan Cwiklinski <johan@x-tnd.be>
- * @copyright 2020-2023 The Galette Team
- * @license   http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
- * @link      http://galette.tuxfamily.org
- * @since     2020-12-07
+ * @author Johan Cwiklinski <johan@x-tnd.be>
  */
 
 class MapsController extends AbstractPluginController

diff --git a/lib/GaletteMaps/Coordinates.php b/lib/GaletteMaps/Coordinates.php
@@ -1,15 +1,9 @@
 <?php
 
-/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
-
 /**
- * Members GPS coordinates
- *
- * PHP version 5
+ * Copyright © 2003-2024 The Galette Team
  *
- * Copyright © 2012-2021 The Galette Team
- *
- * This file is part of Galette (http://galette.tuxfamily.org).
+ * This file is part of Galette (https://galette.eu).
  *
  * Galette is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -23,16 +17,6 @@
  *
  * You should have received a copy of the GNU General Public License
  * along with Galette. If not, see <http://www.gnu.org/licenses/>.
- *
- * @category  Plugins
- * @package   GaletteMaps
- *
- * @author    Johan Cwiklinski <johan@x-tnd.be>
- * @copyright 2012-2021 The Galette Team
- * @license   http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
- * @version   SVN: $Id$
- * @link      http://galette.tuxfamily.org
- * @since     Available since 0.7.4dev - 2012-10-04
  */
 
 namespace GaletteMaps;
@@ -48,14 +32,7 @@
 /**
  * Members GPS coordinates
  *
- * @category  Plugins
- * @name      Coordinates
- * @package   GaletteMaps
- * @author    Johan Cwiklinski <johan@x-tnd.be>
- * @copyright 2012-2021 The Galette Team
- * @license   http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
- * @link      http://galette.tuxfamily.org
- * @since     Available since 0.7.4dev - 2012-10-04
+ * @author Johan Cwiklinski <johan@x-tnd.be>
  */
 
 class Coordinates

diff --git a/lib/GaletteMaps/NominatimTowns.php b/lib/GaletteMaps/NominatimTowns.php
@@ -1,15 +1,9 @@
 <?php
 
-/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
-
 /**
- * Towns GPS coordinates via nominatim
- *
- * PHP version 5
+ * Copyright © 2003-2024 The Galette Team
  *
- * Copyright © 2014 The Galette Team
- *
- * This file is part of Galette (http://galette.tuxfamily.org).
+ * This file is part of Galette (https://galette.eu).
  *
  * Galette is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -23,16 +17,6 @@
  *
  * You should have received a copy of the GNU General Public License
  * along with Galette. If not, see <http://www.gnu.org/licenses/>.
- *
- * @category  Plugins
- * @package   GaletteMaps
- *
- * @author    Johan Cwiklinski <johan@x-tnd.be>
- * @copyright 2014 The Galette Team
- * @license   http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
- * @version   SVN: $Id$
- * @link      http://galette.tuxfamily.org
- * @since     Available since 0.8dev - 2014-09-14
  */
 
 namespace GaletteMaps;
@@ -45,14 +29,7 @@
 /**
  * Towns GPS coordinates via nominatim
  *
- * @category  Plugins
- * @name      NominatimTowns
- * @package   GaletteMaps
- * @author    Johan Cwiklinski <johan@x-tnd.be>
- * @copyright 2012-2014 The Galette Team
- * @license   http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
- * @link      http://galette.tuxfamily.org
- * @since     Available since 0.7.4dev - 2012-10-03
+ * @author Johan Cwiklinski <johan@x-tnd.be>
  */
 
 class NominatimTowns

diff --git a/lib/GaletteMaps/PluginGaletteMaps.php b/lib/GaletteMaps/PluginGaletteMaps.php
@@ -1,15 +1,9 @@
 <?php
 
-/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
-
 /**
- * Members GPS coordinates
- *
- * PHP version 5
+ * Copyright © 2003-2024 The Galette Team
  *
- * Copyright © 2012-2021 The Galette Team
- *
- * This file is part of Galette (http://galette.tuxfamily.org).
+ * This file is part of Galette (https://galette.eu).
  *
  * Galette is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -23,16 +17,6 @@
  *
  * You should have received a copy of the GNU General Public License
  * along with Galette. If not, see <http://www.gnu.org/licenses/>.
- *
- * @category  Plugins
- * @package   GaletteMaps
- *
- * @author    Johan Cwiklinski <johan@x-tnd.be>
- * @copyright 2012-2021 The Galette Team
- * @license   http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
- * @version   SVN: $Id$
- * @link      http://galette.tuxfamily.org
- * @since     Available since 0.7.4dev - 2012-10-04
  */
 
 namespace GaletteMaps;
@@ -44,14 +28,7 @@
 /**
  * Members GPS coordinates
  *
- * @category  Plugins
- * @name      Coordinates
- * @package   GaletteMaps
- * @author    Johan Cwiklinski <johan@x-tnd.be>
- * @copyright 2012-2021 The Galette Team
- * @license   http://www.gnu.org/licenses/gpl-3.0.html GPL License 3.0 or (at your option) any later version
- * @link      http://galette.tuxfamily.org
- * @since     Available since 0.7.4dev - 2012-10-04
+ * @author Johan Cwiklinski <johan@x-tnd.be>
  */
 
 class PluginGaletteMaps extends GalettePlugin

diff --git a/templates/default/common_html.html.twig b/templates/default/common_html.html.twig
@@ -1,4 +1,24 @@
-<div id="legend"">
+{#
+/**
+ * Copyright © 2003-2024 The Galette Team
+ *
+ * This file is part of Galette (https://galette.eu).
+ *
+ * Galette is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Galette is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Galette. If not, see <http://www.gnu.org/licenses/>.
+ */
+#}
+<div id="legend">
     <table>
         <tr>
             <th>

diff --git a/templates/default/common_scripts.html.twig b/templates/default/common_scripts.html.twig
@@ -1,3 +1,23 @@
+{#
+/**
+ * Copyright © 2003-2024 The Galette Team
+ *
+ * This file is part of Galette (https://galette.eu).
+ *
+ * Galette is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Galette is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Galette. If not, see <http://www.gnu.org/licenses/>.
+ */
+#}
 {% if cur_route starts with 'maps_' %}
     <script type="text/javascript" src="{{ url_for("plugin_res", {"plugin": module_id, "path": "maps-main.bundle.min.js"}) }}"></script>
 {% endif %}

diff --git a/templates/default/headers.html.twig b/templates/default/headers.html.twig
@@ -1,3 +1,23 @@
+{#
+/**
+ * Copyright © 2003-2024 The Galette Team
+ *
+ * This file is part of Galette (https://galette.eu).
+ *
+ * Galette is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Galette is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Galette. If not, see <http://www.gnu.org/licenses/>.
+ */
+#}
 {% if cur_route starts with 'maps_' %}
     <link rel="stylesheet" type="text/css" href="{{ url_for("plugin_res", {"plugin": module_id, "path": "maps-main.bundle.min.css"}) }}"/>
     <link rel="stylesheet" type="text/css" href="{{ url_for("plugin_res", {"plugin": module_id, "path": "galette_maps.css"}) }}"/>