aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/phpbb/config_php.php
blob: 8191023437464bc432cfff4b126880456f80d34b (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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
<?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.
*
*/

namespace phpbb;

class config_php
{
	/** @var string phpBB Root Path */
	protected $phpbb_root_path;

	/** @var string php file extension  */
	protected $php_ext;

	/**
	* Indicates if the php config file has been loaded.
	*
	* @var bool
	*/
	protected $config_loaded = false;

	/**
	* The content of the php config file
	*
	* @var array
	*/
	protected $config_data = array();

	/**
	* The path to the config file. (Defaults: $phpbb_root_path . 'config.' . $php_ext)
	*
	* @var string
	*/
	protected $config_file;

	/**
	* Constructor
	*
	* @param string $phpbb_root_path Path to the phpbb includes directory.
	* @param string $php_ext php file extension
	*/
	function __construct($phpbb_root_path, $php_ext)
	{
		$this->phpbb_root_path = $phpbb_root_path;
		$this->php_ext = $php_ext;
		$this->config_file = $this->phpbb_root_path . 'config.' . $this->php_ext;
	}

	/**
	* Set the path to the config file.
	*
	* @param string $config_file
	*/
	public function set_config_file($config_file)
	{
		$this->config_file = $config_file;
		$this->config_loaded = false;
	}

	/**
	* Returns an array containing all the variables defined into the config.php file
	*
	* @return bool|array Return the content of the config file or false if the file does not exists.
	*/
	public function get_all()
	{
		if (!$this->load_config_file())
		{
			return false;
		}

		return $this->config_data;
	}

	/**
	* Return the value of a variable defined into the config.php file and false if the variable does not exist.
	*
	* @param string $variable The name of the variable
	* @return mixed
	*/
	public function get($variable)
	{
		if (!$this->load_config_file())
		{
			return false;
		}

		return isset($this->config_data[$variable]) ? $this->config_data[$variable] : false;
	}

	/**
	* Load the config file and store the information.
	*
	* @return bool True if the file was correctly loaded, false otherwise.
	*/
	protected function load_config_file()
	{
		if (!$this->config_loaded)
		{
			if (file_exists($this->config_file))
			{
				$this->defined_vars = null;
				$this->defined_vars = get_defined_vars();

				require($this->config_file);
				$this->config_data = array_diff_key(get_defined_vars(), $this->defined_vars);

				$this->config_loaded = true;
			}
			else
			{
				return false;
			}
		}

		return true;
	}
}