summaryrefslogtreecommitdiff
path: root/hauth/Hybrid/Error.php
blob: 7013b49761cf94bfb1340f5e689649959d7dfb30 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
<?php

/**
 * HybridAuth
 * http://hybridauth.sourceforge.net | http://github.com/hybridauth/hybridauth
 * (c) 2009-2015, HybridAuth authors | http://hybridauth.sourceforge.net/licenses.html
 */

/**
 * Errors manager
 *
 * HybridAuth errors are stored in Hybrid::storage() and not displayed directly to the end user
 */
class Hybrid_Error {

	/**
	 * Store error in session
	 *
	 * @param string $message  Error message
	 * @param int    $code     Error code
	 * @param string $trace    Back trace
	 * @param string $previous Previous exception
	 */
	public static function setError($message, $code = null, $trace = null, $previous = null) {
		Hybrid_Logger::info("Enter Hybrid_Error::setError( $message )");

		Hybrid_Auth::storage()->set("hauth_session.error.status", 1);
		Hybrid_Auth::storage()->set("hauth_session.error.message", $message);
		Hybrid_Auth::storage()->set("hauth_session.error.code", $code);
		Hybrid_Auth::storage()->set("hauth_session.error.trace", $trace);
		Hybrid_Auth::storage()->set("hauth_session.error.previous", $previous);
	}

	/**
	 * Clear the last error
	 * @return void
	 */
	public static function clearError() {
		Hybrid_Logger::info("Enter Hybrid_Error::clearError()");

		Hybrid_Auth::storage()->delete("hauth_session.error.status");
		Hybrid_Auth::storage()->delete("hauth_session.error.message");
		Hybrid_Auth::storage()->delete("hauth_session.error.code");
		Hybrid_Auth::storage()->delete("hauth_session.error.trace");
		Hybrid_Auth::storage()->delete("hauth_session.error.previous");
	}

	/**
	 * Checks to see if there is a an error.
	 * @return boolean true if there is an error.
	 */
	public static function hasError() {
		return (bool) Hybrid_Auth::storage()->get("hauth_session.error.status");
	}

	/**
	 * Return error message
	 * @return string
	 */
	public static function getErrorMessage() {
		return Hybrid_Auth::storage()->get("hauth_session.error.message");
	}

	/**
	 * Return error code
	 * @return int
	 */
	public static function getErrorCode() {
		return Hybrid_Auth::storage()->get("hauth_session.error.code");
	}

	/**
	 * Return string detailed error backtrace as string
	 * @return string
	 */
	public static function getErrorTrace() {
		return Hybrid_Auth::storage()->get("hauth_session.error.trace");
	}

	/**
	 * Detailed error backtrace as string
	 * @return string
	 */
	public static function getErrorPrevious() {
		return Hybrid_Auth::storage()->get("hauth_session.error.previous");
	}

}