class php_exporter
Class php_exporter Crawls through a list of files and grabs all php-events
Methods
__construct(string $phpbb_root_path, mixed $extension = null, string $min_version = null, string $max_version = null)
|
||
array |
get_events()
Get the list of all events |
|
null |
set_current_event(string $name, int $line)
Set current event data |
|
null |
set_content(array $content)
Set the content of this file |
|
int |
crawl_phpbb_directory_php()
Crawl the phpBB/ directory for php events |
|
get_recursive_file_list()
Returns a list of files in $dir |
||
string |
export_events_for_wiki(string $action = '')
Format the php events as a wiki table |
|
int |
crawl_php_file(string $file)
|
|
string |
get_event_name(int $event_line, bool $is_dispatch)
Find the name of the event inside the dispatch() line |
|
array |
get_vars_from_array()
Find the $vars array |
|
array |
get_vars_from_single_line_array($line, $throw_multiline = true)
Find the variables in single line array |
|
array |
get_vars_from_multi_line_array()
Find the variables in single line array |
|
array |
get_vars_from_docblock()
Find the $vars array |
|
int |
find_since()
Find the "@since" Information line |
|
array |
find_changed(string $tag_name)
Find the "@changed" Information lines |
|
int |
find_event()
Find the "@event" Information line |
|
int |
find_tag(string $find_tag, array $disallowed_tags, int $skip_to_line)
Find a "@*" Information line |
|
int |
find_description()
Find a "@*" Information line |
|
string |
validate_since(string $line)
Validate "@since" Information |
|
string |
validate_changed(string $line)
Validate "@changed" Information |
|
string |
validate_event(string $event_name, string $line)
Validate "@event" Information |
|
null |
validate_vars_docblock_array(array $vars_array, array $vars_docblock)
Validates that two arrays contain the same strings |
Details
at line 55
public
__construct(string $phpbb_root_path, mixed $extension = null, string $min_version = null, string $max_version = null)
at line 77
public array
get_events()
Get the list of all events
at line 89
public null
set_current_event(string $name, int $line)
Set current event data
at line 101
public null
set_content(array $content)
Set the content of this file
at line 110
public int
crawl_phpbb_directory_php()
Crawl the phpBB/ directory for php events
at line 128
public
get_recursive_file_list()
Returns a list of files in $dir
at line 165
public string
export_events_for_wiki(string $action = '')
Format the php events as a wiki table
at line 192
public int
crawl_php_file(string $file)
at line 312
public string
get_event_name(int $event_line, bool $is_dispatch)
Find the name of the event inside the dispatch() line
at line 359
public array
get_vars_from_array()
Find the $vars array
at line 392
public array
get_vars_from_single_line_array($line, $throw_multiline = true)
Find the variables in single line array
at line 419
public array
get_vars_from_multi_line_array()
Find the variables in single line array
at line 444
public array
get_vars_from_docblock()
Find the $vars array
at line 505
public int
find_since()
Find the "@since" Information line
at line 517
public array
find_changed(string $tag_name)
Find the "@changed" Information lines
at line 542
public int
find_event()
Find the "@event" Information line
at line 557
public int
find_tag(string $find_tag, array $disallowed_tags, int $skip_to_line)
Find a "@*" Information line
at line 603
public int
find_description()
Find a "@*" Information line
at line 637
public string
validate_since(string $line)
Validate "@since" Information
at line 657
public string
validate_changed(string $line)
Validate "@changed" Information
at line 679
public string
validate_event(string $event_name, string $line)
Validate "@event" Information
at line 706
public null
validate_vars_docblock_array(array $vars_array, array $vars_docblock)
Validates that two arrays contain the same strings