(feat) rewrite

README.md

@@ -1,3 +1,98 @@
 # OWC IDP UserData
 
-This repository contains interfaces for userdata objects to be used by IDP plugins (e.g. DigiD, eHerkenning)
+This package provides common `UserData` and `Session` classes for identity provider (IDP) plugins such as DigiD, eHerkenning, and eIDAS.
+
+## Installation
+
+Install via Composer:
+
+```bash
+composer require owc/idp-userdata
+```
+
+### Example: Providing User Data via IDP-Specific Filters
+
+To provide user data to the session classes, use the IDP-specific WordPress filters in your plugin or theme:
+
+```php
+use OWC\IdpUserData\DigiDUserData;
+
+add_filter('owc_digid_is_logged_in', function (bool $isLoggedIn): bool {
+    // Your logic to determine if the user is logged in with DigiD
+    return true;
+});
+
+add_filter('owc_digid_userdata', function (?DigiDUserData $userData): ?DigiDUserData {
+    return new DigiDUserData([
+        'bsn' => '123456789',
+    ]);
+});
+```
+
+### Example: Providing User Data via Generic Filter (with switch)
+
+You can also use the generic filters and handle multiple IDPs with a switch statement:
+
+```php
+
+use OWC\IdpUserData\DigiDUserData;
+use OWC\IdpUserData\eHerkenningUserData;
+use OWC\IdpUserData\eIDASUserData;
+use OWC\IdpUserData\IdpSession;
+use OWC\IdpUserData\Idp;
+use OWC\IdpUserData\UserData;
+
+
+add_filter('owc_idp_is_logged_in', function (bool $isLoggedIn, string $idp): bool {
+    switch ($idp) {
+        case Idp::DIGID:
+            // Your logic for DigiD
+            return true;
+        case Idp::EHERKENNING:
+            // Your logic for eHerkenning
+            return false;
+        case Idp::EIDAS:
+            // Your logic for eIDAS
+            return false;
+        default:
+            return $isLoggedIn;
+    }
+}, 10, 2);
+
+add_filter('owc_idp_userdata', function (?UserData $userData, string $idp): ?UserData {
+    switch ($idp) {
+        case Idp::DIGID:
+            return new DigiDUserData([
+                'bsn' => '123456789',
+            ]);
+        case Idp::EHERKENNING:
+            return new eHerkenningUserData([
+                'kvk' => '987654321',
+                'rsin' => '123456789',
+                'vestigingsnummer' => '001',
+                'bsn' => null,
+            ]);
+        case Idp::EIDAS:
+            return new eIDASUserData([
+                'bsn' => '555555555',
+            ]);
+        default:
+            return $userData;
+    }
+}, 10, 2);
+```
+
+### Example: Getting User Data
+
+```php
+use OWC\IdpUserData\DigiDSession;
+use OWC\IdpUserData\DigiDUserData;
+
+if (DigiDSession::isLoggedIn()) {
+    $userData = DigiDSession::getUserData();
+    if ($userData instanceof DigiDUserData) {
+        $bsn = $userData->getBsn();
+        // ...
+    }
+}
+```

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "owc/idp-userdata",
     "type": "library",
-    "description": "Common interfaces for IDP userdata (DigiD, eHerkenning)",
+    "description": "Common userdata classes and session helpers for IDP userdata (DigiD, eHerkenning)",
     "authors": [
         {
             "name": "Yard | Digital Agency",

src/DigiDSession.php

@@ -8,10 +8,10 @@ class DigiDSession extends IdpSession
 {
     protected static function get_idp(): string
     {
-        return 'digid';
+        return Idp::DIGID;
     }
 
-    public static function getUserData(): ?DigiDUserDataInterface
+    public static function getUserData(): ?DigiDUserData
     {
         return parent::getUserData();
     }

src/DigiDUserData.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace OWC\IdpUserData;
+
+class DigiDUserData extends UserData
+{
+    protected string $bsn;
+
+    public function getBsn(): string
+    {
+        return $this->bsn;
+    }
+
+}

src/Idp.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace OWC\IdpUserData;
+
+// TODO: Convert to enums if PHP 8.1+ is supported
+class Idp {
+    public const DIGID = 'digid';
+    public const EHERKENNING = 'eherkenning';
+    public const EIDAS = 'eidas';
+}

src/IdpSession.php

@@ -15,7 +15,7 @@ public static function isLoggedIn(): bool
         return apply_filters('owc_' . static::get_idp() . '_is_logged_in', $isLoggedIn);
     }
 
-    protected static function getUserData(): ?UserDataInterface
+    protected static function getUserData(): ?UserData
     {
         $userData = apply_filters('owc_idp_userdata', null, static::get_idp());
 

src/UserData.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace OWC\IdpUserData;
+
+abstract class UserData
+{
+    protected array $data;
+
+    public function __construct(array $data) {
+        $classVars = get_class_vars(static::class);
+
+        $data = wp_parse_args($data, $classVars);
+        $data = wp_array_slice_assoc($data, array_keys($classVars));
+
+        foreach ($data as $key => $value) {
+            $this->$key = $value;
+        }
+    }
+}

src/eHerkenningSession.php

@@ -8,10 +8,10 @@ class eHerkenningSession extends IdpSession
 {
     protected static function get_idp(): string
     {
-        return 'eherkenning';
+        return Idp::EHERKENNING;
     }
 
-    public static function getUserData(): ?eHerkenningUserDataInterface
+    public static function getUserData(): ?eHerkenningUserData
     {
         return parent::getUserData();
     }

src/eHerkenningUserData.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace OWC\IdpUserData;
+
+class eHerkenningUserdata extends UserData
+{
+    protected string $kvk;
+
+    protected ?string $rsin = null;
+
+    protected ?string $vestigingsnummer = null;
+
+    protected ?string $bsn = null;
+
+    public function getKvk(): string
+    {
+        return $this->kvk;
+    }
+
+    public function getBsn(): ?string
+    {
+        return $this->bsn;
+    }
+
+    public function getRsin(): ?string {
+        return $this->rsin;
+    }
+
+    public function getVestigingsnummer(): ?string {
+        return $this->vestigingsnummer;
+    }
+}

src/eIDASSession.php

@@ -8,10 +8,10 @@ class eIDASSession extends IdpSession
 {
     protected static function get_idp(): string
     {
-        return 'eidas';
+        return Idp::EIDAS;
     }
 
-    public static function getUserData(): ?eIDASUserDataInterface
+    public static function getUserData(): ?eIDASUserData
     {
         return parent::getUserData();
     }

src/eIDASUserData.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OWC\IdpUserData;
+
+class eIDASUserData extends UserData
+{
+    protected string $bsn;
+
+    public function getBsn(): string {
+        return $this->bsn;
+    }
+}