[ Index ]

PHP Cross Reference of phpBB-3.3.7-deutsch

title

Body

[close]

/phpbb/event/ -> php_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: 803 lines (22 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

php_exporter:: (26 methods):
  __construct()
  get_events()
  set_current_event()
  set_content()
  crawl_phpbb_directory_php()
  get_recursive_file_list()
  export_events_for_wiki()
  export_events_for_rst()
  export_events_for_bbcode()
  crawl_php_file()
  version_is_filtered()
  get_event_name()
  preg_match_event_name()
  get_vars_from_array()
  get_vars_from_single_line_array()
  get_vars_from_multi_line_array()
  get_vars_from_docblock()
  find_since()
  find_changed()
  find_event()
  find_tag()
  find_description()
  validate_since()
  validate_changed()
  validate_event()
  validate_vars_docblock_array()


Class: php_exporter  - X-Ref

Class php_exporter
Crawls through a list of files and grabs all php-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

set_current_event($name, $line)   X-Ref
Set current event data

param: string    $name    Name of the current event (used for error messages)
param: int    $line    Line where the current event is placed in
return: null

set_content($content)   X-Ref
Set the content of this file

param: array $content        Array with the lines of the file
return: null

crawl_phpbb_directory_php()   X-Ref
Crawl the phpBB/ directory for php events

return: int    The number of events found

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

return: array    List of files (including the path)

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

param: string $action
return: string

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

param: string $action
return: string

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

param: string $action
return: string

crawl_php_file($file)   X-Ref

param: string $file
return: int Number of events found in this file

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

param: string $version
return: bool

get_event_name($event_line, $is_dispatch)   X-Ref
Find the name of the event inside the dispatch() line

param: int $event_line
param: bool $is_dispatch Do we look for dispatch() or trigger_event() ?
return: string    Name of the event

preg_match_event_name()   X-Ref
Returns a regex match for the event name

return: string

get_vars_from_array()   X-Ref
Find the $vars array

return: array        List of variables

get_vars_from_single_line_array($line, $throw_multiline = true)   X-Ref
Find the variables in single line array

param: string    $line
param: bool    $throw_multiline    Throw an exception when there are too
return: array        List of variables

get_vars_from_multi_line_array()   X-Ref
Find the variables in single line array

return: array        List of variables

get_vars_from_docblock()   X-Ref
Find the $vars array

return: array        List of variables

find_since()   X-Ref
Find the "@since" Information line

return: int Absolute line number

find_changed($tag_name)   X-Ref
Find the "@changed" Information lines

param: string $tag_name Should be 'change', not 'changed'
return: array Absolute line numbers

find_event()   X-Ref
Find the "@event" Information line

return: int Absolute line number

find_tag($find_tag, $disallowed_tags, $skip_to_line = 0)   X-Ref
Find a "@*" Information line

param: string $find_tag        Name of the tag we are trying to find
param: array $disallowed_tags        List of tags that must not appear between
param: int $skip_to_line        Skip lines until this one
return: int Absolute line number

find_description()   X-Ref
Find a "@*" Information line

return: int Absolute line number

validate_since($line)   X-Ref
Validate "@since" Information

param: string $line
return: string

validate_changed($line)   X-Ref
Validate "@changed" Information

param: string $line
return: string

validate_event($event_name, $line)   X-Ref
Validate "@event" Information

param: string $event_name
param: string $line
return: string

validate_vars_docblock_array($vars_array, $vars_docblock)   X-Ref
Validates that two arrays contain the same strings

param: array $vars_array        Variables found in the array line
param: array $vars_docblock    Variables found in the doc block
return: null



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