From e1c93f7d961a8052d16531bfad14869f2347bd71 Mon Sep 17 00:00:00 2001
From: Michiel Kodde <mkodde@ibuildings.nl>
Date: Tue, 2 Apr 2024 09:51:38 +0200
Subject: [PATCH] Install and repair document headers

---
 .docheader                                    | 15 +++++
 composer.json                                 |  1 +
 composer.lock                                 | 60 ++++++++++++++++++-
 src/Surfnet/DataFixtures/AppFixtures.php      | 16 +++++
 .../Migrations/Version20141031133057.php      | 16 +++++
 .../SelfAssertedTokensOptionChangedEvent.php  |  2 +-
 .../Event/SelfVetOptionChangedEvent.php       |  2 +-
 .../Event/SsoOn2faOptionChangedEvent.php      |  2 +-
 .../Configuration/Value/InstitutionRole.php   |  3 +-
 .../Value/SelfAssertedTokensOption.php        |  2 +-
 .../Configuration/Value/SelfVetOption.php     |  2 +-
 .../Configuration/Value/SsoOn2faOption.php    |  2 +-
 .../InstitutionAuthorizationOptionTest.php    |  2 +-
 .../Value/InstitutionRoleTest.php             |  4 +-
 .../MigrateVettedSecondFactorCommand.php      |  2 +-
 ...egisterSelfAssertedSecondFactorCommand.php |  2 +-
 .../Command/SelfVetSecondFactorCommand.php    |  2 +-
 .../RightToObtainDataInterface.php            | 16 +++++
 src/Surfnet/StepupMiddleware/Kernel.php       | 16 +++++
 ...SecondFactorDisplayNameResolverService.php |  2 +-
 ...ndFactorDisplayNameResolverServiceTest.php |  2 +-
 tests/bootstrap.php                           | 16 +++++
 22 files changed, 171 insertions(+), 16 deletions(-)
 create mode 100644 .docheader

diff --git a/.docheader b/.docheader
new file mode 100644
index 000000000..a12ddf880
--- /dev/null
+++ b/.docheader
@@ -0,0 +1,15 @@
+/**
+ * Copyright %regexp:\d{4}% SURFnet %regexp:(B.V.|bv)%
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
diff --git a/composer.json b/composer.json
index 458927657..81a356cd0 100644
--- a/composer.json
+++ b/composer.json
@@ -62,6 +62,7 @@
         "doctrine/data-fixtures": "~1.7",
         "doctrine/doctrine-fixtures-bundle": "^3.5.1",
         "liip/test-fixtures-bundle": "^2.7",
+        "malukenho/docheader": "^1.1",
         "mockery/mockery": "1.7.x-dev",
         "moontoast/math": "^1.2",
         "overtrue/phplint": "*",
diff --git a/composer.lock b/composer.lock
index e94f081b9..a303ac3fc 100644
--- a/composer.lock
+++ b/composer.lock
@@ -4,7 +4,7 @@
         "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
         "This file is @generated automatically"
     ],
-    "content-hash": "4681103c3b1b653100a98769264006bb",
+    "content-hash": "f96114a69480199bd5aa4734329b9506",
     "packages": [
         {
             "name": "beberlei/assert",
@@ -9052,6 +9052,64 @@
             },
             "time": "2020-07-09T08:09:16+00:00"
         },
+        {
+            "name": "malukenho/docheader",
+            "version": "1.1.0",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/malukenho/docheader.git",
+                "reference": "263320d434c727a014650239c90240bbe808bd17"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/malukenho/docheader/zipball/263320d434c727a014650239c90240bbe808bd17",
+                "reference": "263320d434c727a014650239c90240bbe808bd17",
+                "shasum": ""
+            },
+            "require": {
+                "php": "^8.0",
+                "symfony/console": "^4.4 || ^5.4 || ^6.0 || ^7.0",
+                "symfony/finder": "^4.4 || ^5.4 || ^6.0 || ^7.0"
+            },
+            "require-dev": {
+                "doctrine/coding-standard": "^9.0",
+                "mikey179/vfsstream": "^1.6.10",
+                "phpunit/phpunit": "^9.5",
+                "vimeo/psalm": "^4.23 || ^5.0"
+            },
+            "bin": [
+                "bin/docheader"
+            ],
+            "type": "library",
+            "autoload": {
+                "psr-4": {
+                    "DocHeader\\": "src/"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "Jefersson Nathan",
+                    "email": "malukenho.dev@gmail.com"
+                }
+            ],
+            "description": "A small library to check header docs",
+            "homepage": "https://github.com/malukenho/docheader",
+            "keywords": [
+                "Code style",
+                "code standard",
+                "license",
+                "static analysis"
+            ],
+            "support": {
+                "issues": "https://github.com/malukenho/docheader/issues",
+                "source": "https://github.com/malukenho/docheader/tree/1.1.0"
+            },
+            "time": "2024-02-05T12:05:53+00:00"
+        },
         {
             "name": "masterminds/html5",
             "version": "2.8.1",
diff --git a/src/Surfnet/DataFixtures/AppFixtures.php b/src/Surfnet/DataFixtures/AppFixtures.php
index 4207c8246..80479f788 100644
--- a/src/Surfnet/DataFixtures/AppFixtures.php
+++ b/src/Surfnet/DataFixtures/AppFixtures.php
@@ -1,5 +1,21 @@
 <?php
 
+/**
+ * Copyright 2020 SURFnet bv
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 namespace Surfnet\DataFixtures;
 
 use Doctrine\Bundle\FixturesBundle\Fixture;
diff --git a/src/Surfnet/Migrations/Version20141031133057.php b/src/Surfnet/Migrations/Version20141031133057.php
index ddd742321..fcd621039 100644
--- a/src/Surfnet/Migrations/Version20141031133057.php
+++ b/src/Surfnet/Migrations/Version20141031133057.php
@@ -1,5 +1,21 @@
 <?php
 
+/**
+ * Copyright 2014 SURFnet bv
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 namespace Surfnet\Migrations;
 
 use Doctrine\DBAL\Schema\Schema;
diff --git a/src/Surfnet/Stepup/Configuration/Event/SelfAssertedTokensOptionChangedEvent.php b/src/Surfnet/Stepup/Configuration/Event/SelfAssertedTokensOptionChangedEvent.php
index cb50563f6..9480a068d 100644
--- a/src/Surfnet/Stepup/Configuration/Event/SelfAssertedTokensOptionChangedEvent.php
+++ b/src/Surfnet/Stepup/Configuration/Event/SelfAssertedTokensOptionChangedEvent.php
@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Copyright 2022 SURF B.V.
+ * Copyright 2022 SURFnet B.V.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/src/Surfnet/Stepup/Configuration/Event/SelfVetOptionChangedEvent.php b/src/Surfnet/Stepup/Configuration/Event/SelfVetOptionChangedEvent.php
index 17401a337..d5a457139 100644
--- a/src/Surfnet/Stepup/Configuration/Event/SelfVetOptionChangedEvent.php
+++ b/src/Surfnet/Stepup/Configuration/Event/SelfVetOptionChangedEvent.php
@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Copyright 2021 SURF B.V.
+ * Copyright 2021 SURFnet B.V.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/src/Surfnet/Stepup/Configuration/Event/SsoOn2faOptionChangedEvent.php b/src/Surfnet/Stepup/Configuration/Event/SsoOn2faOptionChangedEvent.php
index c912a8631..e2c288066 100644
--- a/src/Surfnet/Stepup/Configuration/Event/SsoOn2faOptionChangedEvent.php
+++ b/src/Surfnet/Stepup/Configuration/Event/SsoOn2faOptionChangedEvent.php
@@ -3,7 +3,7 @@
 declare(strict_types=1);
 
 /**
- * Copyright 2022 SURF B.V.
+ * Copyright 2022 SURFnet B.V.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/src/Surfnet/Stepup/Configuration/Value/InstitutionRole.php b/src/Surfnet/Stepup/Configuration/Value/InstitutionRole.php
index 992011338..fb67efd30 100644
--- a/src/Surfnet/Stepup/Configuration/Value/InstitutionRole.php
+++ b/src/Surfnet/Stepup/Configuration/Value/InstitutionRole.php
@@ -1,9 +1,10 @@
 <?php
+
 /**
  * Copyright 2018 SURFnet B.V.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not select this file except in compliance with the License.
+ * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *     http://www.apache.org/licenses/LICENSE-2.0
diff --git a/src/Surfnet/Stepup/Configuration/Value/SelfAssertedTokensOption.php b/src/Surfnet/Stepup/Configuration/Value/SelfAssertedTokensOption.php
index eb2afa458..df29b5776 100644
--- a/src/Surfnet/Stepup/Configuration/Value/SelfAssertedTokensOption.php
+++ b/src/Surfnet/Stepup/Configuration/Value/SelfAssertedTokensOption.php
@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Copyright 2022 SURF B.V.
+ * Copyright 2022 SURFnet B.V.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/src/Surfnet/Stepup/Configuration/Value/SelfVetOption.php b/src/Surfnet/Stepup/Configuration/Value/SelfVetOption.php
index 7946a3a93..106d36581 100644
--- a/src/Surfnet/Stepup/Configuration/Value/SelfVetOption.php
+++ b/src/Surfnet/Stepup/Configuration/Value/SelfVetOption.php
@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Copyright 2021 SURF B.V.
+ * Copyright 2021 SURFnet B.V.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/src/Surfnet/Stepup/Configuration/Value/SsoOn2faOption.php b/src/Surfnet/Stepup/Configuration/Value/SsoOn2faOption.php
index cc529d77d..fbacf05e2 100644
--- a/src/Surfnet/Stepup/Configuration/Value/SsoOn2faOption.php
+++ b/src/Surfnet/Stepup/Configuration/Value/SsoOn2faOption.php
@@ -3,7 +3,7 @@
 declare(strict_types=1);
 
 /**
- * Copyright 2022 SURF B.V.
+ * Copyright 2022 SURFnet B.V.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/src/Surfnet/Stepup/Tests/Configuration/Value/InstitutionAuthorizationOptionTest.php b/src/Surfnet/Stepup/Tests/Configuration/Value/InstitutionAuthorizationOptionTest.php
index 0b3351fe5..8496cf977 100644
--- a/src/Surfnet/Stepup/Tests/Configuration/Value/InstitutionAuthorizationOptionTest.php
+++ b/src/Surfnet/Stepup/Tests/Configuration/Value/InstitutionAuthorizationOptionTest.php
@@ -4,7 +4,7 @@
  * Copyright 2018 SURFnet B.V.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not select this file except in compliance with the License.
+ * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *     http://www.apache.org/licenses/LICENSE-2.0
diff --git a/src/Surfnet/Stepup/Tests/Configuration/Value/InstitutionRoleTest.php b/src/Surfnet/Stepup/Tests/Configuration/Value/InstitutionRoleTest.php
index 2be542e49..fa7f8bb09 100644
--- a/src/Surfnet/Stepup/Tests/Configuration/Value/InstitutionRoleTest.php
+++ b/src/Surfnet/Stepup/Tests/Configuration/Value/InstitutionRoleTest.php
@@ -1,10 +1,10 @@
 <?php
 
 /**
- * Copyright 2018 SURFnet B.V.
+ * Copyright 2018 SURFnet bv
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not select this file except in compliance with the License.
+ * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *     http://www.apache.org/licenses/LICENSE-2.0
diff --git a/src/Surfnet/StepupMiddleware/CommandHandlingBundle/Identity/Command/MigrateVettedSecondFactorCommand.php b/src/Surfnet/StepupMiddleware/CommandHandlingBundle/Identity/Command/MigrateVettedSecondFactorCommand.php
index e9981d3f4..740326e5c 100644
--- a/src/Surfnet/StepupMiddleware/CommandHandlingBundle/Identity/Command/MigrateVettedSecondFactorCommand.php
+++ b/src/Surfnet/StepupMiddleware/CommandHandlingBundle/Identity/Command/MigrateVettedSecondFactorCommand.php
@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Copyright 2021 SURF bv
+ * Copyright 2021 SURFnet B.V.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/src/Surfnet/StepupMiddleware/CommandHandlingBundle/Identity/Command/RegisterSelfAssertedSecondFactorCommand.php b/src/Surfnet/StepupMiddleware/CommandHandlingBundle/Identity/Command/RegisterSelfAssertedSecondFactorCommand.php
index 397ed94f3..04afd31ce 100644
--- a/src/Surfnet/StepupMiddleware/CommandHandlingBundle/Identity/Command/RegisterSelfAssertedSecondFactorCommand.php
+++ b/src/Surfnet/StepupMiddleware/CommandHandlingBundle/Identity/Command/RegisterSelfAssertedSecondFactorCommand.php
@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Copyright 2022 SURF bv
+ * Copyright 2022 SURFnet bv
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/src/Surfnet/StepupMiddleware/CommandHandlingBundle/Identity/Command/SelfVetSecondFactorCommand.php b/src/Surfnet/StepupMiddleware/CommandHandlingBundle/Identity/Command/SelfVetSecondFactorCommand.php
index 7fc0b4310..17c82f9b1 100644
--- a/src/Surfnet/StepupMiddleware/CommandHandlingBundle/Identity/Command/SelfVetSecondFactorCommand.php
+++ b/src/Surfnet/StepupMiddleware/CommandHandlingBundle/Identity/Command/SelfVetSecondFactorCommand.php
@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Copyright 2021 SURF bv
+ * Copyright 2021 SURFnet bv
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/src/Surfnet/StepupMiddleware/CommandHandlingBundle/SensitiveData/RightToObtainDataInterface.php b/src/Surfnet/StepupMiddleware/CommandHandlingBundle/SensitiveData/RightToObtainDataInterface.php
index 6b10e9972..9e92f0c53 100644
--- a/src/Surfnet/StepupMiddleware/CommandHandlingBundle/SensitiveData/RightToObtainDataInterface.php
+++ b/src/Surfnet/StepupMiddleware/CommandHandlingBundle/SensitiveData/RightToObtainDataInterface.php
@@ -1,5 +1,21 @@
 <?php
 
+/**
+ * Copyright 2022 SURFnet B.V.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 namespace Surfnet\StepupMiddleware\CommandHandlingBundle\SensitiveData;
 
 interface RightToObtainDataInterface
diff --git a/src/Surfnet/StepupMiddleware/Kernel.php b/src/Surfnet/StepupMiddleware/Kernel.php
index 51f692d8b..3446340f3 100644
--- a/src/Surfnet/StepupMiddleware/Kernel.php
+++ b/src/Surfnet/StepupMiddleware/Kernel.php
@@ -1,5 +1,21 @@
 <?php
 
+/**
+ * Copyright 2024 SURFnet bv
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 namespace Surfnet\StepupMiddleware;
 
 use Symfony\Bundle\FrameworkBundle\Kernel\MicroKernelTrait;
diff --git a/src/Surfnet/StepupMiddleware/MiddlewareBundle/Service/SecondFactorDisplayNameResolverService.php b/src/Surfnet/StepupMiddleware/MiddlewareBundle/Service/SecondFactorDisplayNameResolverService.php
index c0ff7f3a8..0882c86ad 100644
--- a/src/Surfnet/StepupMiddleware/MiddlewareBundle/Service/SecondFactorDisplayNameResolverService.php
+++ b/src/Surfnet/StepupMiddleware/MiddlewareBundle/Service/SecondFactorDisplayNameResolverService.php
@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Copyright 2020 SURF B.V.
+ * Copyright 2020 SURFnet B.V.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/src/Surfnet/StepupMiddleware/MiddlewareBundle/Tests/Service/SecondFactorDisplayNameResolverServiceTest.php b/src/Surfnet/StepupMiddleware/MiddlewareBundle/Tests/Service/SecondFactorDisplayNameResolverServiceTest.php
index bb5a42b01..b8429fac7 100644
--- a/src/Surfnet/StepupMiddleware/MiddlewareBundle/Tests/Service/SecondFactorDisplayNameResolverServiceTest.php
+++ b/src/Surfnet/StepupMiddleware/MiddlewareBundle/Tests/Service/SecondFactorDisplayNameResolverServiceTest.php
@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Copyright 2020 SURF bv.
+ * Copyright 2020 SURFnet bv
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
diff --git a/tests/bootstrap.php b/tests/bootstrap.php
index 469dccee4..8a716bd9e 100644
--- a/tests/bootstrap.php
+++ b/tests/bootstrap.php
@@ -1,5 +1,21 @@
 <?php
 
+/**
+ * Copyright 2020 SURFnet bv
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 use Symfony\Component\Dotenv\Dotenv;
 
 require dirname(__DIR__).'/vendor/autoload.php';