aboutsummaryrefslogtreecommitdiffstats
path: root/tests/mock/session_testable.php
blob: 7828a864d42b614deb36afff2c20c39058a03c58 (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
/**
*
* This file is part of the phpBB Forum Software package.
*
* @copyright (c) phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
* For full copyright and license information, please see
* the docs/CREDITS.txt file.
*
*/

/**
* Extends the session class to overwrite the setting of cookies.
*
* The session class directly writes cookie headers making it impossible to
* test it without warnings about sent headers. This class only stores cookie
* data for later verification.
*/
class phpbb_mock_session_testable extends \phpbb\session
{
	private $_cookies = array();

	public function set_cookie($name, $data, $time, $httponly = true)
	{
		$this->_cookies[$name] = array($data, $time);
	}

	/**
	* Checks if the cookies were set correctly.
	*
	* @param PHPUnit\Framework\Assert test    The test from which this is called
	* @param array(string => mixed)   cookies The cookie data to check against.
	*				The keys are cookie names, the values can either be null to
	*				check only the existence of the cookie, or an array(d, t),
	*				where d is the cookie data to check, or null to skip the
	*				check and t is the cookie time to check, or null to skip.
	*/
	public function check_cookies(PHPUnit\Framework\Assert $test, $cookies)
	{
		$test->assertEquals(array_keys($cookies), array_keys($this->_cookies), 'Incorrect cookies were set');

		foreach ($cookies as $name => $cookie)
		{
			if (!is_null($cookie))
			{
				$data = $cookie[0];
				$time = $cookie[1];

				if (!is_null($data))
				{
					$test->assertEquals($data, $this->_cookies[$name][0], "Cookie $name contains incorrect data");
				}

				if (!is_null($time))
				{
					$test->assertEquals($time, $this->_cookies[$name][1], "Cookie $name expires at the wrong time");
				}
			}
		}
	}

	public function setup()
	{
	}
}