md_exporter
class md_exporter
Crawls through a markdown file and grabs all events
Properties
protected string | $path | ||
protected string | $root_path | ||
protected string | $min_version | ||
protected string | $max_version | ||
protected string | $filter | ||
protected string | $current_event | ||
protected array | $events |
Methods
No description
Get the list of all events
No description
No description
No description
The version to check
Format the md events as a rst table
Format the md events as BBCode list
Validates a template event name
Validate "Since" Information
Validate "Changed" Information
Validate "version" Information
Validate the files list
Get all template events in a template file
Validates whether all events from $file are in the md file and vice-versa
Returns a list of files in $dir
Details
at line 48
__construct(string $phpbb_root_path, mixed $extension = null, string $min_version = null, string $max_version = null)
No description
at line 69
array
get_events()
Get the list of all events
at line 79
int
crawl_phpbb_directory_adm(string $md_file)
No description
at line 98
int
crawl_phpbb_directory_styles(string $md_file)
No description
at line 125
int
crawl_eventsmd(string $md_file, string $filter)
No description
at line 239
protected bool
version_is_filtered(string $version)
The version to check
at line 252
string
export_events_for_wiki(string $action = '')
deprecated
deprecated
Format the md events as a wiki table
at line 308
string
export_events_for_rst(string $action = '')
Format the md events as a rst table
at line 373
string
export_events_for_bbcode(string $action = '')
Format the md events as BBCode list
at line 432
null
validate_event_name($event_name)
Validates a template event name
at line 447
string
validate_since(string $since)
Validate "Since" Information
at line 464
string
validate_changed(string $changed)
Validate "Changed" Information
at line 490
bool
validate_version(string $version)
Validate "version" Information
at line 502
array
validate_file_list(string $file_details)
Validate the files list
at line 571
array
crawl_file_for_events(string $file)
Get all template events in a template file
at line 594
true
validate_events_from_file(string $file, array $events)
Validates whether all events from $file are in the md file and vice-versa
at line 654
array
get_recursive_file_list(string $dir)
Returns a list of files in $dir
Works recursive with any depth