aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/includes/hook/finder.php
blob: 065e685514b7a19d7f85ab41c21ed8878e51b614 (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
<?php
/**
*
* @package extension
* @copyright (c) 2013 phpBB Group
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
*
*/

/**
* @ignore
*/
if (!defined('IN_PHPBB'))
{
	exit;
}

/**
* The hook finder locates installed hooks.
*
* @package phpBB3
*/
class phpbb_hook_finder
{
	protected $phpbb_root_path;
	protected $cache;
	protected $php_ext;

	/**
	* Creates a new finder instance.
	*
	* @param string $phpbb_root_path Path to the phpbb root directory
	* @param string $php_ext php file extension
	* @param phpbb_cache_driver_interface $cache A cache instance or null
	*/
	public function __construct($phpbb_root_path, $php_ext, phpbb_cache_driver_interface $cache = null)
	{
		$this->phpbb_root_path = $phpbb_root_path;
		$this->cache = $cache;
		$this->php_ext = $php_ext;
	}

	/**
	* Finds all hook files.
	*
	* @param bool $cache Whether the result should be cached
	* @return array An array of paths to found hook files
	*/
	public function find($cache = true)
	{
		if (!defined('DEBUG') && $cache && $this->cache)
		{
			$hook_files = $this->cache->get('_hooks');
			if ($hook_files !== false)
			{
				return $hook_files;
			}
		}

		$hook_files = array();

		// Now search for hooks...
		$dh = @opendir($this->phpbb_root_path . 'includes/hooks/');

		if ($dh)
		{
			while (($file = readdir($dh)) !== false)
			{
				if (strpos($file, 'hook_') === 0 && substr($file, -(strlen($this->php_ext) + 1)) === '.' . $this->php_ext)
				{
					$hook_files[] = substr($file, 0, -(strlen($this->php_ext) + 1));
				}
			}
			closedir($dh);
		}

		if ($cache && $this->cache)
		{
			$this->cache->put('_hooks', $hook_files);
		}

		return $hook_files;
	}
}