Reformat SimpleSAML_Auth_Source.

lib/SimpleSAML/Auth/Source.php

 <?php
 
+
 /**
  * This class defines a base class for authentication source.
  *
@@ -8,7 +9,8 @@
  * @author Olav Morken, UNINETT AS.
  * @package simpleSAMLphp
  */
-abstract class SimpleSAML_Auth_Source {
+abstract class SimpleSAML_Auth_Source
+{
 
 
     /**
@@ -29,7 +31,8 @@ abstract class SimpleSAML_Auth_Source {
      * @param array $info Information about this authentication source.
      * @param array &$config Configuration for this authentication source.
      */
-	public function __construct($info, &$config) {
+    public function __construct($info, &$config)
+    {
         assert('is_array($info)');
         assert('is_array($config)');
 
@@ -42,10 +45,12 @@ abstract class SimpleSAML_Auth_Source {
      * Get sources of a specific type.
      *
      * @param string $type The type of the authentication source.
+     *
      * @return SimpleSAML_Auth_Source[]  Array of SimpleSAML_Auth_Source objects of the specified type.
      * @throws Exception If the authentication source is invalid.
      */
-	public static function getSourcesOfType($type) {
+    public static function getSourcesOfType($type)
+    {
         assert('is_string($type)');
 
         $config = SimpleSAML_Configuration::getConfig('authsources.php');
@@ -57,8 +62,10 @@ abstract class SimpleSAML_Auth_Source {
             $source = $config->getArray($id);
 
             if (!array_key_exists(0, $source) || !is_string($source[0])) {
-				throw new Exception('Invalid authentication source \'' . $id .
-					'\': First element must be a string which identifies the authentication source.');
+                throw new Exception(
+                    'Invalid authentication source \''.$id.
+                    '\': First element must be a string which identifies the authentication source.'
+                );
             }
 
             if ($source[0] !== $type) {
@@ -77,8 +84,8 @@ abstract class SimpleSAML_Auth_Source {
      *
      * @return string The ID of this authentication source.
      */
-	public function getAuthId() {
-
+    public function getAuthId()
+    {
         return $this->authId;
     }
 
@@ -108,10 +115,11 @@ abstract class SimpleSAML_Auth_Source {
      *
      * @param array &$state Information about the current authentication.
      */
-	public function reauthenticate(array &$state) {
+    public function reauthenticate(array &$state)
+    {
         assert('isset($state["ReturnCallback"])');
 
-		/* The default implementation just copies over the previous authentication data. */
+        // the default implementation just copies over the previous authentication data
         $session = SimpleSAML_Session::getSessionFromRequest();
         $data = $session->getAuthState($this->authId);
         foreach ($data as $k => $v) {
@@ -129,7 +137,8 @@ abstract class SimpleSAML_Auth_Source {
      *
      * @param array &$state Information about the current authentication.
      */
-	public static function completeAuth(&$state) {
+    public static function completeAuth(&$state)
+    {
         assert('is_array($state)');
         assert('array_key_exists("LoginCompletedHandler", $state)');
 
@@ -139,7 +148,7 @@ abstract class SimpleSAML_Auth_Source {
         assert('is_callable($func)');
 
         call_user_func($func, $state);
-		assert(FALSE);
+        assert(false);
     }
 
 
@@ -156,10 +165,10 @@ abstract class SimpleSAML_Auth_Source {
      *
      * @param array &$state Information about the current logout operation.
      */
-	public function logout(&$state) {
+    public function logout(&$state)
+    {
         assert('is_array($state)');
-
-		/* Default logout handler which doesn't do anything. */
+        // default logout handler which doesn't do anything
     }
 
 
@@ -172,7 +181,8 @@ abstract class SimpleSAML_Auth_Source {
      *
      * @param array &$state Information about the current authentication.
      */
-	public static function completeLogout(&$state) {
+    public static function completeLogout(&$state)
+    {
         assert('is_array($state)');
         assert('array_key_exists("LogoutCompletedHandler", $state)');
 
@@ -182,7 +192,7 @@ abstract class SimpleSAML_Auth_Source {
         assert('is_callable($func)');
 
         call_user_func($func, $state);
-		assert(FALSE);
+        assert(false);
     }
 
 
@@ -194,20 +204,23 @@ abstract class SimpleSAML_Auth_Source {
      *
      * @param string $authId The authentication source identifier.
      * @param array  $config The configuration.
+     *
      * @return SimpleSAML_Auth_Source The parsed authentication source.
      * @throws Exception If the authentication source is invalid.
      */
-	private static function parseAuthSource($authId, $config) {
+    private static function parseAuthSource($authId, $config)
+    {
         assert('is_string($authId)');
         assert('is_array($config)');
 
         if (!array_key_exists(0, $config) || !is_string($config[0])) {
-			throw new Exception('Invalid authentication source \'' . $authId .
-				'\': First element must be a string which identifies the authentication source.');
+            throw new Exception(
+                'Invalid authentication source \''.$authId.
+                '\': First element must be a string which identifies the authentication source.'
+            );
         }
 
-		$className = SimpleSAML_Module::resolveClass($config[0], 'Auth_Source',
-			'SimpleSAML_Auth_Source');
+        $className = SimpleSAML_Module::resolveClass($config[0], 'Auth_Source', 'SimpleSAML_Auth_Source');
 
         $info = array('AuthId' => $authId);
         unset($config[0]);
@@ -228,36 +241,42 @@ abstract class SimpleSAML_Auth_Source {
      *
      * @param string      $authId The authentication source identifier.
      * @param string|NULL $type The type of authentication source. If NULL, any type will be accepted.
+     *
      * @return SimpleSAML_Auth_Source|NULL The AuthSource object, or NULL if no authentication
      *     source with the given identifier is found.
      * @throws SimpleSAML_Error_Exception If no such authentication source is found or it is invalid.
      */
-	public static function getById($authId, $type = NULL) {
+    public static function getById($authId, $type = null)
+    {
         assert('is_string($authId)');
         assert('is_null($type) || is_string($type)');
 
-		/* For now - load and parse config file. */
+        // for now - load and parse config file
         $config = SimpleSAML_Configuration::getConfig('authsources.php');
 
-		$authConfig = $config->getArray($authId, NULL);
-		if ($authConfig === NULL) {
-			if ($type !== NULL) {
-				throw new SimpleSAML_Error_Exception('No authentication source with id ' .
-					var_export($authId, TRUE) . ' found.');
+        $authConfig = $config->getArray($authId, null);
+        if ($authConfig === null) {
+            if ($type !== null) {
+                throw new SimpleSAML_Error_Exception(
+                    'No authentication source with id '.
+                    var_export($authId, true).' found.'
+                );
             }
-			return NULL;
+            return null;
         }
 
         $ret = self::parseAuthSource($authId, $authConfig);
 
-		if ($type === NULL || $ret instanceof $type) {
+        if ($type === null || $ret instanceof $type) {
             return $ret;
         }
 
-		/* The authentication source doesn't have the correct type. */
-		throw new SimpleSAML_Error_Exception('Invalid type of authentication source ' .
-			var_export($authId, TRUE) . '. Was ' . var_export(get_class($ret), TRUE) .
-			', should be ' . var_export($type, TRUE) . '.');
+        // the authentication source doesn't have the correct type
+        throw new SimpleSAML_Error_Exception(
+            'Invalid type of authentication source '.
+            var_export($authId, true).'. Was '.var_export(get_class($ret), true).
+            ', should be '.var_export($type, true).'.'
+        );
     }
 
 
@@ -273,12 +292,13 @@ abstract class SimpleSAML_Auth_Source {
      * @param string $assoc The identifier for this logout association.
      * @param array  $state The state array passed to the authenticate-function.
      */
-	protected function addLogoutCallback($assoc, $state) {
+    protected function addLogoutCallback($assoc, $state)
+    {
         assert('is_string($assoc)');
         assert('is_array($state)');
 
         if (!array_key_exists('LogoutCallback', $state)) {
-			/* The authentication requester doesn't have a logout callback. */
+            // the authentication requester doesn't have a logout callback
             return;
         }
         $callback = $state['LogoutCallback'];
@@ -296,10 +316,13 @@ abstract class SimpleSAML_Auth_Source {
             'state'    => $callbackState,
         );
 
-
         $session = SimpleSAML_Session::getSessionFromRequest();
-		$session->setData('SimpleSAML_Auth_Source.LogoutCallbacks', $id, $data,
-			SimpleSAML_Session::DATA_TIMEOUT_SESSION_END);
+        $session->setData(
+            'SimpleSAML_Auth_Source.LogoutCallbacks',
+            $id,
+            $data,
+            SimpleSAML_Session::DATA_TIMEOUT_SESSION_END
+        );
     }
 
 
@@ -313,7 +336,8 @@ abstract class SimpleSAML_Auth_Source {
      *
      * @param string $assoc The logout association which should be called.
      */
-	protected function callLogoutCallback($assoc) {
+    protected function callLogoutCallback($assoc)
+    {
         assert('is_string($assoc)');
 
         $id = strlen($this->authId).':'.$this->authId.$assoc;
@@ -321,8 +345,8 @@ abstract class SimpleSAML_Auth_Source {
         $session = SimpleSAML_Session::getSessionFromRequest();
 
         $data = $session->getData('SimpleSAML_Auth_Source.LogoutCallbacks', $id);
-		if ($data === NULL) {
-			/* FIXME: fix for IdP-first flow (issue 397) -> reevaluate logout callback infrastructure */
+        if ($data === null) {
+            // FIXME: fix for IdP-first flow (issue 397) -> reevaluate logout callback infrastructure
             $session->doLogout($this->authId);
 
             return;
@@ -345,11 +369,10 @@ abstract class SimpleSAML_Auth_Source {
      *
      * @return array The id of all authentication sources.
      */
-	public static function getSources() {
-
+    public static function getSources()
+    {
         $config = SimpleSAML_Configuration::getOptionalConfig('authsources.php');
 
         return $config->getOptions();
     }
-
 }