Documentor
Documentor
Tags
Table of Contents
- $prefixes : array<string|int, string>
- Prefixes.
- $relative : string
- Relative path.
- $type : string
- Document type 'actions' or 'filters'.
- $hooks : array<string|int, Hook>
- Hooks.
- __construct() : mixed
- Construct documentor.
- get_actions() : array<string|int, mixed>
- Get actions.
- get_filters() : array<string|int, mixed>
- Get filters.
- get_hooks() : array<string|int, mixed>
- Get hooks.
- parse() : mixed
- Parse.
- relative() : string
- Get relative path.
- get_statement_doc_comment() : string|null
- Get statement doc document.
- should_parse_tag() : bool
- Check if the specified tag name should be parsed.
Properties
$prefixes
Prefixes.
public
array<string|int, string>
$prefixes
$relative
Relative path.
public
string
$relative
$type
Document type 'actions' or 'filters'.
public
string
$type
$hooks
Hooks.
private
array<string|int, Hook>
$hooks
Methods
__construct()
Construct documentor.
public
__construct() : mixed
Return values
mixed —get_actions()
Get actions.
public
get_actions() : array<string|int, mixed>
Return values
array<string|int, mixed> —get_filters()
Get filters.
public
get_filters() : array<string|int, mixed>
Return values
array<string|int, mixed> —get_hooks()
Get hooks.
public
get_hooks() : array<string|int, mixed>
Return values
array<string|int, mixed> —parse()
Parse.
public
parse(SplFileInfo $file) : mixed
Parameters
- $file : SplFileInfo
-
File.
Tags
Return values
mixed —relative()
Get relative path.
public
relative(SplFileInfo $file) : string
Parameters
- $file : SplFileInfo
-
File.
Return values
string —get_statement_doc_comment()
Get statement doc document.
private
get_statement_doc_comment(Node $statement) : string|null
Parameters
- $statement : Node
-
Statement.
Return values
string|null —should_parse_tag()
Check if the specified tag name should be parsed.
private
should_parse_tag(string $name) : bool
Parameters
- $name : string
-
Tag name.
Return values
bool —True if should parse, false otherwise.