1 files changed, 97 insertions, 52 deletions

diff --git a/daggerhart-openid-connect-generic/includes/openid-connect-generic-login-form.php b/daggerhart-openid-connect-generic/includes/openid-connect-generic-login-form.php
index 25c48a2..a4a13db 100755..100644
--- a/daggerhart-openid-connect-generic/includes/openid-connect-generic-login-form.php
+++ b/daggerhart-openid-connect-generic/includes/openid-connect-generic-login-form.php
@@ -1,89 +1,120 @@
 <?php
-
+/**
+ * Login form and login button handlong class.
+ *
+ * @package   OpenID_Connect_Generic
+ * @category  Login
+ * @author    Jonathan Daggerhart <jonathan@daggerhart.com>
+ * @copyright 2015-2020 daggerhart
+ * @license   http://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
+ */
+
+/**
+ * OpenID_Connect_Generic_Login_Form class.
+ *
+ * Login form and login button handlong.
+ *
+ * @package OpenID_Connect_Generic
+ * @category  Login
+ */
 class OpenID_Connect_Generic_Login_Form {
 
+	/**
+	 * Plugin settings object.
+	 *
+	 * @var OpenID_Connect_Generic_Option_Settings
+	 */
 	private $settings;
+
+	/**
+	 * Plugin client wrapper instance.
+	 *
+	 * @var OpenID_Connect_Generic_Client_Wrapper
+	 */
 	private $client_wrapper;
 
 	/**
-	 * @param $settings
-	 * @param $client_wrapper
+	 * The class constructor.
+	 *
+	 * @param OpenID_Connect_Generic_Option_Settings $settings       A plugin settings object instance.
+	 * @param OpenID_Connect_Generic_Client_Wrapper  $client_wrapper A plugin client wrapper object instance.
 	 */
-	function __construct( $settings, $client_wrapper ){
+	function __construct( $settings, $client_wrapper ) {
 		$this->settings = $settings;
 		$this->client_wrapper = $client_wrapper;
 
-		// maybe set redirect cookie on formular page
-		add_action('login_form_login', [$this, 'handle_redirect_cookie']);
+		// Handle setting the redirect cookie on a formu page.
+		add_action( 'login_form_login', array( $this, 'handle_redirect_cookie' ) );
 	}
 
 	/**
-	 * @param $settings
-	 * @param $client_wrapper
+	 * Create an instance of the OpenID_Connect_Generic_Login_Form class.
 	 *
-	 * @return \OpenID_Connect_Generic_Login_Form
+	 * @param OpenID_Connect_Generic_Option_Settings $settings       A plugin settings object instance.
+	 * @param OpenID_Connect_Generic_Client_Wrapper  $client_wrapper A plugin client wrapper object instance.
+	 *
+	 * @return void
 	 */
-	static public function register( $settings, $client_wrapper ){
+	static public function register( $settings, $client_wrapper ) {
 		$login_form = new self( $settings, $client_wrapper );
 
-		// alter the login form as dictated by settings
+		// Alter the login form as dictated by settings.
 		add_filter( 'login_message', array( $login_form, 'handle_login_page' ), 99 );
 
-                // allow extensions to also hook the login form
-                do_action ( 'openid-connect-generic-register-login-form', $login_form );
+		// Allow extensions to hook the login form.
+		do_action( 'openid-connect-generic-register-login-form', $login_form );
 
-		// add a shortcode for the login button
+		// Add a shortcode for the login button.
 		add_shortcode( 'openid_connect_generic_login_button', array( $login_form, 'make_login_button' ) );
 
 		$login_form->handle_redirect_login_type_auto();
-
-		return $login_form;
 	}
 
 	/**
-	 * Auto Login redirect
+	 * Auto Login redirect.
+	 *
+	 * @return void
 	 */
-	function handle_redirect_login_type_auto()
-	{
-		if ( $GLOBALS['pagenow'] == 'wp-login.php'
-			&& ( $this->settings->login_type == 'auto' || ! empty( $_GET['force_redirect'] ) )
-			&& ( ! isset( $_GET[ 'action' ] ) || $_GET[ 'action' ] !== 'logout' )
-			&& ! isset( $_POST['wp-submit'] ) )
-		{
-			if (  ! isset( $_GET['login-error'] ) ) {
-			    $this->handle_redirect_cookie();
+	function handle_redirect_login_type_auto() {
+
+		if ( 'wp-login.php' == $GLOBALS['pagenow']
+			&& ( 'auto' == $this->settings->login_type || ! empty( $_GET['force_redirect'] ) )
+			&& ( ! isset( $_GET['action'] ) || 'logout' !== $_GET['action'] )
+			&& ! isset( $_POST['wp-submit'] ) ) {
+			if ( ! isset( $_GET['login-error'] ) ) {
+				$this->handle_redirect_cookie();
 				wp_redirect( $this->client_wrapper->get_authentication_url() );
 				exit;
-			}
-			else {
+			} else {
 				add_action( 'login_footer', array( $this, 'remove_login_form' ), 99 );
 			}
 		}
+
 	}
 
 	/**
-	 * Handle login related redirects
+	 * Handle login related redirects.
+	 *
+	 * @return void
 	 */
-	function handle_redirect_cookie()
-	{
-		if ( $GLOBALS['pagenow'] == 'wp-login.php' && isset( $_GET[ 'action' ] ) && $_GET[ 'action' ] === 'logout' ) {
+	function handle_redirect_cookie() {
+		if ( isset( $GLOBALS['pagenow'] ) && 'wp-login.php' == $GLOBALS['pagenow'] && isset( $_GET['action'] ) && 'logout' === $_GET['action'] ) {
 			return;
 		}
 
-		// record the URL of this page if set to redirect back to origin page
-		if ( $this->settings->redirect_user_back )
-		{
-			$redirect_expiry = current_time('timestamp') + DAY_IN_SECONDS;
+		// Record the URL of this page if set to redirect back to origin page.
+		if ( $this->settings->redirect_user_back ) {
+			$redirect_expiry = current_time( 'timestamp' ) + DAY_IN_SECONDS;
 
-			// default redirect to the homepage
+			// Default redirect to the homepage.
 			$redirect_url = home_url( esc_url( add_query_arg( null, null ) ) );
 
-			if ( $GLOBALS['pagenow'] == 'wp-login.php' ) {
-				// if using the login form, default redirect to the admin dashboard
+			if ( isset( $GLOBALS['pagenow'] ) && 'wp-login.php' == $GLOBALS['pagenow'] ) {
+				// If using the login form, default redirect to the admin dashboard.
 				$redirect_url = admin_url();
 
 				if ( isset( $_REQUEST['redirect_to'] ) ) {
-					$redirect_url = esc_url_raw( $_REQUEST[ 'redirect_to' ] );
+					$redirect_url = esc_url_raw( $_REQUEST['redirect_to'] );
 				}
 			}
 
@@ -94,9 +125,10 @@ class OpenID_Connect_Generic_Login_Form {
 	}
 
 	/**
-	 * Implements filter login_message
+	 * Implements filter login_message.
+	 *
+	 * @param string $message The text message to display on the login page.
 	 *
-	 * @param $message
 	 * @return string
 	 */
 	function handle_login_page( $message ) {
@@ -105,15 +137,17 @@ class OpenID_Connect_Generic_Login_Form {
 			$message .= $this->make_error_output( $_GET['login-error'], $_GET['message'] );
 		}
 
-		// login button is appended to existing messages in case of error
+		// Login button is appended to existing messages in case of error.
 		$message .= $this->make_login_button();
+
 		return $message;
 	}
 
 	/**
-	 * Display an error message to the user
+	 * Display an error message to the user.
 	 *
-	 * @param $error_code
+	 * @param string $error_code    The error code.
+	 * @param string $error_message The error message test.
 	 *
 	 * @return string
 	 */
@@ -122,21 +156,29 @@ class OpenID_Connect_Generic_Login_Form {
 		ob_start();
 		?>
 		<div id="login_error">
-			<strong><?php _e( 'ERROR'); ?>: </strong>
-			<?php print esc_html($error_message); ?>
+			<strong><?php printf( __( 'ERROR (%1$s)', 'daggerhart-openid-connect-generic' ), $error_code ); ?>: </strong>
+			<?php print esc_html( $error_message ); ?>
 		</div>
 		<?php
 		return ob_get_clean();
 	}
 
 	/**
-	 * Create a login button (link)
+	 * Create a login button (link).
+	 *
+	 * @param array $atts Array of optional attributes to override login buton
+	 * functionality when used by shortcode.
 	 *
 	 * @return string
 	 */
-	function make_login_button() {
-		$text = apply_filters( 'openid-connect-generic-login-button-text', __( 'Login with OpenID Connect' ) );
-		$href = apply_filters( 'openid-connect-generic-login-button-url', $this->client_wrapper->get_authentication_url() );
+	function make_login_button( $atts = array() ) {
+		$button_text = __( 'Login with OpenID Connect', 'daggerhart-openid-connect-generic' );
+		if ( ! empty( $atts['button_text'] ) ) {
+			$button_text = $atts['button_text'];
+		}
+
+		$text = apply_filters( 'openid-connect-generic-login-button-text', $button_text );
+		$href = $this->client_wrapper->get_authentication_url( $atts );
 
 		ob_start();
 		?>
@@ -147,8 +189,10 @@ class OpenID_Connect_Generic_Login_Form {
 		return ob_get_clean();
 	}
 
-	/*
+	/**
 	 * Removes the login form from the HTML DOM
+	 *
+	 * @return void
 	 */
 	function remove_login_form() {
 		?>
@@ -161,4 +205,5 @@ class OpenID_Connect_Generic_Login_Form {
 		</script>
 		<?php
 	}
+
 }