summaryrefslogtreecommitdiffstats
path: root/lib/SimpleSAML/Error/AuthSource.php
blob: 48e28daccdeb17f40eb3c56b645adf7a630b4309 (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
<?php
/**
 * Baseclass for auth source exceptions.
 * 
 * @package SimpleSAMLphp_base
 *
 */
class SimpleSAML_Error_AuthSource extends SimpleSAML_Error_Error {


	/**
	 * Authsource module name.
	 */
	private $authsource;


	/**
	 * Reason why this request was invalid.
	 */
	private $reason;


	/**
	 * Create a new AuthSource error.
	 *
	 * @param string $authsource  Authsource module name from where this error was thrown.
	 * @param string $reason  Description of the error.
	 */
	public function __construct($authsource, $reason, $cause = NULL) {
		assert('is_string($authsource)');
		assert('is_string($reason)');

		$this->authsource = $authsource;
		$this->reason = $reason;
		parent::__construct(
			array(
				'AUTHSOURCEERROR',
				'%AUTHSOURCE%' => htmlspecialchars(var_export($this->authsource, TRUE)),
				'%REASON%' => htmlspecialchars(var_export($this->reason, TRUE))
			),
			$cause
		);

		$this->message = "Error with authentication source '$authsource': $reason";
	}


	/**
	 * Retrieve the authsource module name from where this error was thrown.
	 *
	 * @return string  Authsource module name.
	 */
	public function getAuthSource() {
		return $this->authsource;
	}


	/**
	 * Retrieve the reason why the request was invalid.
	 *
	 * @return string  The reason why the request was invalid.
	 */
	public function getReason() {
		return $this->reason;
	}

	
}