codehaiku / subway-2.0

shortcodes/subway-shortcodes.php

Doc Comments +3 added lines, -3 removed lines

@@ -39,7 +39,7 @@ 
     /**
      * Class Constructor.
      *
-     * @return void
+     * @return Shortcodes
      */
     private function __construct() 
     {
@@ -53,7 +53,7 @@ 
     /**
      * Instantiate our class.
      * 
-     * @return mixed The instance of this class.
+     * @return Shortcodes|null The instance of this class.
      */
     public static function instance() 
     {
@@ -91,7 +91,7 @@ 
     /**
      * Displays the login form
      * 
-     * @return void
+     * @return null|string
      */
     public function loginForm() 
     {

Indentation +109 added lines, -109 removed lines

@@ -20,7 +20,7 @@ 
 namespace Subway;
 
 if (! defined('ABSPATH') ) {
-    return;
+	return;
 }
 
 /**
@@ -36,153 +36,153 @@ 
 final class Shortcodes
 {
 
-    /**
-     * Class Constructor.
-     *
-     * @return void
-     */
-    private function __construct() 
-    {
+	/**
+	 * Class Constructor.
+	 *
+	 * @return void
+	 */
+	private function __construct() 
+	{
         
-        add_action('init', array( $this, 'register'));
+		add_action('init', array( $this, 'register'));
         
-        return $this;
+		return $this;
 
-    }
+	}
 
-    /**
-     * Instantiate our class.
-     * 
-     * @return mixed The instance of this class.
-     */
-    public static function instance() 
-    {
+	/**
+	 * Instantiate our class.
+	 * 
+	 * @return mixed The instance of this class.
+	 */
+	public static function instance() 
+	{
         
-        static $instance = null;
+		static $instance = null;
 
-        if (null === $instance ) {
+		if (null === $instance ) {
 
-            $instance = new Shortcodes();
+			$instance = new Shortcodes();
 
-        }
+		}
 
-        return $instance;
+		return $instance;
 
-    }
+	}
 
-    /**
-     * Instantiate our class.
-     * 
-     * @return void
-     */
-    public function register() 
-    {
+	/**
+	 * Instantiate our class.
+	 * 
+	 * @return void
+	 */
+	public function register() 
+	{
 
-        add_shortcode('subway_login', array( $this, 'loginForm' ));
+		add_shortcode('subway_login', array( $this, 'loginForm' ));
 
-        add_action('login_form_middle', array( $this, 'loginFormAction' ), 10, 2);
+		add_action('login_form_middle', array( $this, 'loginFormAction' ), 10, 2);
 
-        add_action('login_form_middle', array( $this, 'lostPasswordLink' ), 10, 2);
+		add_action('login_form_middle', array( $this, 'lostPasswordLink' ), 10, 2);
 
-        return;
+		return;
 
-    }
+	}
 
-    /**
-     * Displays the login form
-     * 
-     * @return void
-     */
-    public function loginForm() 
-    {
+	/**
+	 * Displays the login form
+	 * 
+	 * @return void
+	 */
+	public function loginForm() 
+	{
         
-        $atts = array();
+		$atts = array();
 
-        return $this->renderTemplate($atts, 'login-form.php');
+		return $this->renderTemplate($atts, 'login-form.php');
          
-    }
-
-    /**
-     * Include the specific plugin file if there is no template file.
-     * 
-     * @param mixed  $atts The shortcode attribute.
-     * @param string $file The shortcode template file.
-     * 
-     * @return string The html template content.
-     */
-    protected function renderTemplate( $atts, $file = '' ) 
-    {
-
-        ob_start();
-
-        if (empty($file) ) {
+	}
+
+	/**
+	 * Include the specific plugin file if there is no template file.
+	 * 
+	 * @param mixed  $atts The shortcode attribute.
+	 * @param string $file The shortcode template file.
+	 * 
+	 * @return string The html template content.
+	 */
+	protected function renderTemplate( $atts, $file = '' ) 
+	{
+
+		ob_start();
+
+		if (empty($file) ) {
             
-            return;
+			return;
 
-        }
+		}
 
-        $template = SUBWAY_DIR_PATH . 'templates/'.$file;
+		$template = SUBWAY_DIR_PATH . 'templates/'.$file;
 
-        if (file_exists($template) ) {
+		if (file_exists($template) ) {
 
-            $theme_template = locate_template(array('gears/shortcodes/'.$file ));
+			$theme_template = locate_template(array('gears/shortcodes/'.$file ));
 
-            if ($theme_template) {
+			if ($theme_template) {
 
-                   $template = $theme_template;
+				   $template = $theme_template;
 
-            }
+			}
 
-            include $template;
+			include $template;
 
-        } else {
+		} else {
 
-            echo sprintf(
-                esc_html_e(
-                    'Subway Error: Unable to find template file in: %1s', 'subway'
-                ), 
-                $template
-            );
+			echo sprintf(
+				esc_html_e(
+					'Subway Error: Unable to find template file in: %1s', 'subway'
+				), 
+				$template
+			);
 
-        }
+		}
 
-        return ob_get_clean();
-    }
+		return ob_get_clean();
+	}
 
-    /**
-     * The action for our login form.
-     * 
-     * @param string $__content The current filtered contents.
-     * 
-     * @return string            The content of our login form action.
-     */
-    public function loginFormAction( $__content ) 
-    {
+	/**
+	 * The action for our login form.
+	 * 
+	 * @param string $__content The current filtered contents.
+	 * 
+	 * @return string            The content of our login form action.
+	 */
+	public function loginFormAction( $__content ) 
+	{
 
-        ob_start();
+		ob_start();
         
-        do_action('login_form');
+		do_action('login_form');
         
-        return $__content . ob_get_clean();
-
-    }
-
-     /**
-     * The action for our 'lost password' link.
-     * 
-     * @param string $content The current filtered contents.
-     * 
-     * @return string          The content of our lost password link.
-     */
-    public function lostPasswordLink( $content ) 
-    {
+		return $__content . ob_get_clean();
+
+	}
+
+	 /**
+	  * The action for our 'lost password' link.
+	  * 
+	  * @param string $content The current filtered contents.
+	  * 
+	  * @return string          The content of our lost password link.
+	  */
+	public function lostPasswordLink( $content ) 
+	{
         
-        return $content . $this->renderTemplate(
-            array(), 
-            'login-form-lost-password.php'
-        );
+		return $content . $this->renderTemplate(
+			array(), 
+			'login-form-lost-password.php'
+		);
 
-    }
+	}
 
 }