Add simple login policy implementation

Author: ilijastuden

src/LoginPolicy/LoginPolicy.php

@@ -0,0 +1,160 @@
+<?php
+
+/*
+ * This file is part of the Active Collab Authentication project.
+ *
+ * (c) A51 doo <[email protected]>. All rights reserved.
+ */
+
+namespace ActiveCollab\Authentication\LoginPolicy;
+
+/**
+ * @package ActiveCollab\Authentication\LoginPolicy
+ */
+class LoginPolicy implements LoginPolicyInterface
+{
+    /**
+     * @var string
+     */
+    private $username_format;
+
+    /**
+     * @var bool
+     */
+    private $remember_extends_session;
+
+    /**
+     * @var bool
+     */
+    private $password_change_enabled;
+
+    /**
+     * @var bool
+     */
+    private $password_recovery_enabled;
+
+    /**
+     * @var string
+     */
+    private $external_login_url;
+
+    /**
+     * @var string
+     */
+    private $external_logout_url;
+
+    /**
+     * @var string
+     */
+    private $external_change_password_url;
+
+    /**
+     * @var string
+     */
+    private $external_update_profile_url;
+
+    /**
+     * LoginPolicy constructor.
+     *
+     * @param string $username_format
+     * @param bool   $remember_extends_session
+     * @param bool   $password_change_enabled
+     * @param bool   $password_recovery_enabled
+     * @param string $external_login_url
+     * @param string $external_logout_url
+     * @param string $external_change_password_url
+     * @param string $external_update_profile_url
+     */
+    public function __construct($username_format, $remember_extends_session, $password_change_enabled, $password_recovery_enabled, $external_login_url, $external_logout_url, $external_change_password_url, $external_update_profile_url)
+    {
+        $this->username_format = $username_format;
+        $this->remember_extends_session = (bool) $remember_extends_session;
+        $this->password_change_enabled = (bool) $password_change_enabled;
+        $this->password_recovery_enabled = (bool) $password_recovery_enabled;
+        $this->external_login_url = $external_login_url;
+        $this->external_logout_url = $external_logout_url;
+        $this->external_change_password_url = $external_change_password_url;
+        $this->external_update_profile_url = $external_update_profile_url;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getUsernameFormat()
+    {
+        return $this->username_format;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function rememberExtendsSession()
+    {
+        return $this->remember_extends_session;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function isPasswordChangeEnabled()
+    {
+        return $this->password_change_enabled;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function isPasswordRecoveryEnabled()
+    {
+        return $this->password_recovery_enabled;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getExternalLoginUrl()
+    {
+        return $this->external_login_url;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getExternalLogoutUrl()
+    {
+        return $this->external_logout_url;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getExternalChangePasswordUrl()
+    {
+        return $this->external_change_password_url;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getExternalUpdateProfileUrl()
+    {
+        return $this->external_update_profile_url;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function jsonSerialize()
+    {
+        return [
+            'username_format' => $this->getUsernameFormat(),
+            'remember_extends_session' => $this->rememberExtendsSession(),
+            'password_change_enabled' => $this->isPasswordChangeEnabled(),
+            'password_recovery_enabled' => $this->isPasswordRecoveryEnabled(),
+            'external_login_url' => $this->getExternalLoginUrl(),
+            'external_logout_url' => $this->getExternalLogoutUrl(),
+            'external_change_password_url' => $this->getExternalChangePasswordUrl(),
+            'external_update_profile_url' => $this->getExternalUpdateProfileUrl(),
+        ];
+    }
+}

src/Policy/LoginPolicyInterface.php renamed to src/LoginPolicy/LoginPolicyInterface.php

@@ -6,10 +6,13 @@
  * (c) A51 doo <[email protected]>. All rights reserved.
  */
 
-namespace ActiveCollab\Authentication\Policy;
+namespace ActiveCollab\Authentication\LoginPolicy;
 
 use JsonSerializable;
 
+/**
+ * @package ActiveCollab\Authentication\LoginPolicy
+ */
 interface LoginPolicyInterface extends JsonSerializable
 {
     const USERNAME_FORMAT_TEXT = 'text';
@@ -23,22 +26,10 @@ interface LoginPolicyInterface extends JsonSerializable
     public function getUsernameFormat();
 
     /**
-     * Check is text username format.
-     *
-     * @return bool
-     */
-    public function isUsernameTextFormat();
-
-    /**
-     * Check is email username format.
+     * Enable Remember Me feature to support extended sessions.
      *
      * @return bool
      */
-    public function isUsernameEmailFormat();
-
-    /**
-     * Enable Remember Me feature to support extended sessions.
-     */
     public function rememberExtendsSession();
 
     /**
@@ -60,26 +51,26 @@ public function isPasswordRecoveryEnabled();
      *
      * @return string|null
      */
-    public function getLoginUrl();
+    public function getExternalLoginUrl();
 
     /**
      * Get logout URL.
      *
      * @return string
      */
-    public function getLogoutUrl();
+    public function getExternalLogoutUrl();
 
     /**
      * Get change password URL.
      *
      * @return string|null
      */
-    public function getChangePasswordUrl();
+    public function getExternalChangePasswordUrl();
 
     /**
      * Get update profile URL.
      *
      * @return string|null
      */
-    public function getUpdateProfileUrl();
+    public function getExternalUpdateProfileUrl();
 }