[ Index ]

PHP Cross Reference of phpBB-3.3.7-deutsch

title

Body

[close]

/phpbb/event/ -> md_exporter.php (summary)

This file is part of the phpBB Forum Software package.

Copyright: (c) phpBB Limited
License: GNU General Public License, version 2 (GPL-2.0)
File Size: 692 lines (17 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

md_exporter:: (17 methods):
  __construct()
  get_events()
  crawl_phpbb_directory_adm()
  crawl_phpbb_directory_styles()
  crawl_eventsmd()
  version_is_filtered()
  export_events_for_wiki()
  export_events_for_rst()
  export_events_for_bbcode()
  validate_event_name()
  validate_since()
  validate_changed()
  validate_version()
  validate_file_list()
  crawl_file_for_events()
  validate_events_from_file()
  get_recursive_file_list()


Class: md_exporter  - X-Ref

Crawls through a markdown file and grabs all events

__construct($phpbb_root_path, $extension = null, $min_version = null, $max_version = null)   X-Ref

param: string $phpbb_root_path
param: mixed $extension    String 'vendor/ext' to filter, null for phpBB core
param: string $min_version
param: string $max_version

get_events()   X-Ref
Get the list of all events

return: array        Array with events: name => details

crawl_phpbb_directory_adm($md_file)   X-Ref

param: string $md_file    Relative from phpBB root
return: int        Number of events found

crawl_phpbb_directory_styles($md_file)   X-Ref

param: string $md_file    Relative from phpBB root
return: int        Number of events found

crawl_eventsmd($md_file, $filter)   X-Ref

param: string $md_file    Relative from phpBB root
param: string $filter        Should be 'styles' or 'adm'
return: int        Number of events found

version_is_filtered($version)   X-Ref
The version to check

param: string $version
return: bool

export_events_for_wiki($action = '')   X-Ref
Format the md events as a wiki table

param: string $action
return: string        Number of events found * @deprecated since 3.2

export_events_for_rst(string $action = '')   X-Ref
Format the md events as a rst table

param: string $action
return: string        Number of events found

export_events_for_bbcode(string $action = '')   X-Ref
Format the md events as BBCode list

param: string $action
return: string        Events BBCode

validate_event_name($event_name)   X-Ref
Validates a template event name

param: $event_name
return: null

validate_since($since)   X-Ref
Validate "Since" Information

param: string $since
return: string

validate_changed($changed)   X-Ref
Validate "Changed" Information

param: string $changed
return: string

validate_version($version)   X-Ref
Validate "version" Information

param: string $version
return: bool True if valid, false otherwise

validate_file_list($file_details)   X-Ref
Validate the files list

param: string $file_details
return: array

crawl_file_for_events($file)   X-Ref
Get all template events in a template file

param: string $file
return: array

validate_events_from_file($file, array $events)   X-Ref
Validates whether all events from $file are in the md file and vice-versa

param: string $file
param: array $events
return: true

get_recursive_file_list($dir)   X-Ref
Returns a list of files in $dir

Works recursive with any depth

param: string    $dir    Directory to go through
return: array    List of files (including directories)



Generated: Thu Mar 24 21:31:15 2022 Cross-referenced by PHPXref 0.7.1