Merge pull request #66 from reducktion/add-docs

Add links to source information about algorithms and others

Author: JoaoFSCruz

src/Core/Italy/ItalyCitizenInformationExtractor.php

@@ -9,6 +9,13 @@
 use Reducktion\Socrates\Constants\Gender;
 use Reducktion\Socrates\Contracts\CitizenInformationExtractor;
 
+/**
+ * Class ItalyCitizenInformationExtractor
+ *
+ * Algorithm adapted from: http://www.dossier.net/utilities/codice-fiscale/decreto1974_2227.html and https://en.wikipedia.org/wiki/Italian_fiscal_code.
+ *
+ * @package Reducktion\Socrates\Core\Italy
+ */
 class ItalyCitizenInformationExtractor implements CitizenInformationExtractor
 {
     public function extract(string $id): Citizen

src/Core/Italy/ItalyIdValidator.php

@@ -5,6 +5,13 @@
 use Reducktion\Socrates\Contracts\IdValidator;
 use Reducktion\Socrates\Exceptions\InvalidLengthException;
 
+/**
+ * Class ItalyIdValidator
+ *
+ * Algorithm adapted from: http://www.dossier.net/utilities/codice-fiscale/decreto1974_2227.html and https://en.wikipedia.org/wiki/Italian_fiscal_code.
+ *
+ * @package Reducktion\Socrates\Core\Italy
+ */
 class ItalyIdValidator implements IdValidator
 {
     public function validate(string $id): bool

src/Core/Italy/ItalyRegionsList.php

@@ -2,6 +2,13 @@
 
 namespace Reducktion\Socrates\Core\Italy;
 
+/**
+ * Class ItalyRegionsList
+ *
+ * Data taken from: https://web.archive.org/web/20160819012136/http://www.agenziaentrate.gov.it/wps/wcm/connect/321b0500426a5e2492629bc065cef0e8/codicicatastali_comuni_29_11_2010.pdf?MOD=AJPERES&CACHEID=321b500426a5e2492629bc065cef0e8
+ *
+ * @package Reducktion\Socrates\Core\Italy
+ */
 class ItalyRegionsList
 {
     public static $regions = [

src/Core/Portugal/PortugalIdValidator.php

@@ -6,6 +6,13 @@
 use Reducktion\Socrates\Contracts\IdValidator;
 use Reducktion\Socrates\Exceptions\InvalidLengthException;
 
+/**
+ * Class PortugalIdValidator
+ *
+ * Algorithm adapted from: https://www.autenticacao.gov.pt/documents/20126/115760/Valida%C3%A7%C3%A3o+de+N%C3%BAmero+de+Documento+do+Cart%C3%A3o+de+Cidad%C3%A3o.pdf/bdc4eb37-7316-3ff4-164a-f869382b7053.
+ *
+ * @package Reducktion\Socrates\Core\Portugal
+ */
 class PortugalIdValidator implements IdValidator
 {
     public function validate(string $id): bool

src/Core/Spain/SpainIdValidator.php

@@ -5,6 +5,13 @@
 use Reducktion\Socrates\Contracts\IdValidator;
 use Reducktion\Socrates\Exceptions\InvalidLengthException;
 
+/**
+ * Class SpainIdValidator
+ *
+ * Algorithm adapted from: http://www.interior.gob.es/web/servicios-al-ciudadano/dni/calculo-del-digito-de-control-del-nif-nie.
+ *
+ * @package Reducktion\Socrates\Core\Spain
+ */
 class SpainIdValidator implements IdValidator
 {
     public function validate(string $id): bool