php_exporter
class php_exporter
Class php_exporter Crawls through a list of files and grabs all php-events
Properties
protected string | $path | ||
protected string | $root_path | ||
protected string | $min_version | ||
protected string | $max_version | ||
protected string | $current_file | ||
protected string | $current_event | ||
protected int | $current_event_line | ||
protected array | $events | ||
protected array | $file_lines |
Methods
No description
Get the list of all events
Set current event data
Set the content of this file
Crawl the phpBB/ directory for php events
Returns a list of files in $dir
Format the PHP events as a rst table
Format the PHP events as a BBCode list
No description
The version to check
Find the name of the event inside the dispatch() line
Returns a regex match for the event name
Find the $vars array
Find the variables in single line array
Find the variables in single line array
Find the $vars array
Find the "@since" Information line
Find the "@changed" Information lines
Find the "@event" Information line
Find a "@*" Information line
Find a "@*" Information line
Validate "@since" Information
Validate "@changed" Information
Validate "@event" Information
Validates that two arrays contain the same strings
Details
at line 55
__construct(string $phpbb_root_path, mixed $extension = null, string $min_version = null, string $max_version = null)
No description
at line 77
array
get_events()
Get the list of all events
at line 89
null
set_current_event(string $name, int $line)
Set current event data
at line 101
null
set_content(array $content)
Set the content of this file
at line 110
int
crawl_phpbb_directory_php()
Crawl the phpBB/ directory for php events
at line 128
array
get_recursive_file_list()
Returns a list of files in $dir
at line 166
string
export_events_for_wiki(string $action = '')
deprecated
deprecated
Format the php events as a wiki table
at line 194
string
export_events_for_rst(string $action = '')
Format the PHP events as a rst table
at line 216
string
export_events_for_bbcode(string $action = '')
Format the PHP events as a BBCode list
at line 246
int
crawl_php_file(string $file)
No description
at line 383
protected bool
version_is_filtered(string $version)
The version to check
at line 397
string
get_event_name(int $event_line, bool $is_dispatch)
Find the name of the event inside the dispatch() line
at line 433
protected string
preg_match_event_name()
Returns a regex match for the event name
at line 444
array
get_vars_from_array()
Find the $vars array
at line 477
array
get_vars_from_single_line_array(string $line, bool $throw_multiline = true)
Find the variables in single line array
at line 504
array
get_vars_from_multi_line_array()
Find the variables in single line array
at line 529
array
get_vars_from_docblock()
Find the $vars array
at line 590
int
find_since()
Find the "@since" Information line
at line 602
array
find_changed(string $tag_name)
Find the "@changed" Information lines
at line 627
int
find_event()
Find the "@event" Information line
at line 642
int
find_tag(string $find_tag, array $disallowed_tags, int $skip_to_line = 0)
Find a "@*" Information line
at line 688
int
find_description()
Find a "@*" Information line
at line 722
string
validate_since(string $line)
Validate "@since" Information
at line 742
string
validate_changed(string $line)
Validate "@changed" Information
at line 764
string
validate_event(string $event_name, string $line)
Validate "@event" Information
at line 791
null
validate_vars_docblock_array(array $vars_array, array $vars_docblock)
Validates that two arrays contain the same strings