makary/phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-06-28 06:08:52 +00:00
Code Issues Projects Releases Packages Wiki Activity

[ticket/12273] Grab name of events with a function

Browse source 
PHPBB3-12273
This commit is contained in:
Joas Schilling 2014-04-17 16:55:36 +02:00
parent 6c57edf3a3
commit 5387511f89
1 changed files with 80 additions and 35 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

103
phpBB/develop/event_exporter.php
View file

@ -105,45 +105,26 @@ class event_exporter
$events = array(); $events = array();
$content = file_get_contents($this->root_path . $file); $content = file_get_contents($this->root_path . $file);
if (strpos($content, "phpbb_dispatcher->trigger_event('") || strpos($content, "phpbb_dispatcher->dispatch('")) if (strpos($content, "dispatcher->trigger_event('") || strpos($content, "dispatcher->dispatch('"))
{ {
$lines = explode("\n", $content); $lines = explode("\n", $content);
for ($i = 0, $num_lines = sizeof($lines); $i < $num_lines; $i++) for ($i = 0, $num_lines = sizeof($lines); $i < $num_lines; $i++)
{ {
$event_line = 0; $event_line = 0;
$found_trigger_event = strpos($lines[$i], "phpbb_dispatcher->trigger_event('"); $found_trigger_event = strpos($lines[$i], "dispatcher->trigger_event('");
if ($found_trigger_event !== false) if ($found_trigger_event !== false)
{ {
$event_line = $i; $event_line = $i;
$event_name = $lines[$event_line]; $event_name = $this->get_trigger_event_name($file, $lines[$event_line]);
$event_name = substr($event_name, $found_trigger_event + strlen("phpbb_dispatcher->trigger_event('"));
$event_name = substr($event_name, 0, strpos($event_name, "'"));
$current_line = trim($lines[$event_line]);
$arguments = array();
$found_inline_array = strpos($current_line, "', compact(array('");
if ($found_inline_array !== false)
{
$varsarray = substr($current_line, $found_inline_array + strlen("', compact(array('"), -6);
$arguments = explode("', '", $varsarray);
}
if (empty($arguments))
{
// Find $vars array lines // Find $vars array lines
$find_varsarray_line = 1; $vars_line = ltrim($lines[$event_line - 1], "\t");
while (strpos($lines[$event_line - $find_varsarray_line], "\$vars = array('") === false) if (strpos($vars_line, "\$vars = array('") !== 0)
{
$find_varsarray_line++;
if ($find_varsarray_line > min(50, $event_line))
{ {
throw new LogicException('Can not find "$vars = array()"-line for event "' . $event_name . '" in file "' . $file . '"'); throw new LogicException('Can not find "$vars = array()"-line for event "' . $event_name . '" in file "' . $file . '"');
} }
} $varsarray = substr($vars_line, strlen("\$vars = array('"), 0 - strlen('\');'));
$varsarray = substr(trim($lines[$event_line - $find_varsarray_line]), strlen("\$vars = array('"), -3);
$arguments = explode("', '", $varsarray); $arguments = explode("', '", $varsarray);
}
// Validate $vars array with @var // Validate $vars array with @var
$find_vars_line = 3; $find_vars_line = 3;
@ -167,15 +148,17 @@ class event_exporter
throw new LogicException('$vars array does not match the list of @var tags for event "' . $event_name . '" in file "' . $file . '"'); throw new LogicException('$vars array does not match the list of @var tags for event "' . $event_name . '" in file "' . $file . '"');
} }
} }
$found_dispatch = strpos($lines[$i], "phpbb_dispatcher->dispatch('");
if (!$event_line)
{
$found_dispatch = strpos($lines[$i], "dispatcher->dispatch('");
if ($found_dispatch !== false) if ($found_dispatch !== false)
{ {
$event_line = $i; $event_line = $i;
$event_name = $lines[$event_line]; $event_name = $this->get_dispatch_name($file, $lines[$event_line]);
$event_name = substr($event_name, $found_dispatch + strlen("phpbb_dispatcher->dispatch('"));
$event_name = substr($event_name, 0, strpos($event_name, "'"));
$arguments = array(); $arguments = array();
} }
}
if ($event_line) if ($event_line)
{ {
@ -205,6 +188,68 @@ class event_exporter
return $events; return $events;
} }
/**
* Find the name of the event inside the dispatch() line
*
* @param string $file
* @param string $event_line
* @return int Absolute line number
*/
public function get_dispatch_name($file, $event_line)
{
$event_line = ltrim($event_line, "\t");
$regex = '#\$([a-z](?:[a-z0-9_]|->)*)';
$regex .= '->dispatch\(';
$regex .= '\'' . $this->preg_match_event_name() . '\'';
$regex .= '\);#';
$match = array();
preg_match($regex, $event_line, $match);
if (!isset($match[2]))
{
throw new LogicException('Can not find event name in line "' . $event_line . '" in file "' . $file . '"', 1);
}
return $match[2];
}
/**
* Find the name of the event inside the trigger_event() line
*
* @param string $file
* @param string $event_line
* @return int Absolute line number
*/
public function get_trigger_event_name($file, $event_line)
{
$event_line = ltrim($event_line, "\t");
$regex = '#extract\(\$([a-z](?:[a-z0-9_]|->)*)';
$regex .= '->trigger_event\(';
$regex .= '\'' . $this->preg_match_event_name() . '\'';
$regex .= ', compact\(\$vars\)\)\);#';
$match = array();
preg_match($regex, $event_line, $match);
if (!isset($match[2]))
{
throw new LogicException('Can not find event name in line "' . $event_line . '" in file "' . $file . '"', 1);
}
return $match[2];
}
/**
* Find the name of the event inside the trigger_event() line
*
* @return string Returns a regex match for the event name
*/
protected function preg_match_event_name()
{
return '([a-z][a-z0-9_]*(?:\.[a-z][a-z0-9_]*)+)';
}
/** /**
* Find the "@since" Information line * Find the "@since" Information line
* *