State: Add $allowMissing parameter to loadState().

olavmo-sikt · olavmo-sikt · commit ff5ae8f16a6b · 2011-10-18T11:02:59.000Z
git-svn-id: https://simplesamlphp.googlecode.com/svn/trunk@2947 44740490-163a-0410-bde0-09ae8108e29a
diff --git a/lib/SimpleSAML/Auth/State.php b/lib/SimpleSAML/Auth/State.php
@@ -150,12 +150,13 @@ public static function saveState(&$state, $stage, $rawId = FALSE) {
 	 *
 	 * @param string $id  State identifier (with embedded restart information).
 	 * @param string $stage  The stage the state should have been saved in.
-	 * @return array  State information.
+	 * @param bool $allowMissing  Whether to allow the state to be missing.
+	 * @return array|NULL  State information, or NULL if the state is missing and $allowMissing is TRUE.
 	 */
-	public static function loadState($id, $stage) {
+	public static function loadState($id, $stage, $allowMissing = FALSE) {
 		assert('is_string($id)');
 		assert('is_string($stage)');
-
+		assert('is_bool($allowMissing)');
 		SimpleSAML_Logger::debug('Loading state: ' . var_export($id, TRUE));
 
 		$tmp = explode(':', $id, 2);
@@ -170,7 +171,10 @@ public static function loadState($id, $stage) {
 		$state = $session->getData('SimpleSAML_Auth_State', $id);
 
 		if ($state === NULL) {
-			/* Could not find saved data. Attempt to restart. */
+			/* Could not find saved data. */
+			if ($allowMissing) {
+				return NULL;
+			}
 
 			if ($restartURL === NULL) {
 				throw new SimpleSAML_Error_NoState();
