Hook
Hook
Tags
Table of Contents
- $arguments : array<string|int, Argument>
- Arguments.
- $call : FuncCall
- Function call.
- $changelog : Changelog|null
- Changelog.
- $doc_block : DocBlock|null
- Doc block.
- $doc_comment : Doc|null
- Doc comment.
- $file : SplFileInfo
- File.
- $tag : string
- Tag.
- __construct() : mixed
- Construct hook.
- get_arguments() : array<string|int, mixed>
- Arguments.
- get_call() : FuncCall
- Get call.
- get_changelog() : Changelog|null
- Changelog.
- get_description() : string|null
- Get description.
- get_doc_block() : DocBlock|null
- Get doc block.
- get_doc_comment() : Doc|null
- Get doc comment.
- get_end_line() : int
- Get end line.
- get_file() : SplFileInfo
- Get file.
- get_since() : Since|null
- Get since.
- get_since_version() : string|null
- Get since version.
- get_start_line() : int
- Get start line.
- get_summary() : string|null
- Get summary.
- get_tag() : Tag
- Get tag.
- is_action() : bool
- Is action.
- is_deprecated() : bool
- Is deprecated.
- is_filter() : bool
- Is filter.
- set_changelog() : mixed
- Set changelog.
- set_doc_block() : void
- Set doc block.
- set_doc_comment() : mixed
- Set doc comment.
- tag() : string
- Tag.
Properties
$arguments
Arguments.
public
array<string|int, Argument>
$arguments
$call
Function call.
private
FuncCall
$call
Tags
$changelog
Changelog.
private
Changelog|null
$changelog
$doc_block
Doc block.
private
DocBlock|null
$doc_block
Tags
$doc_comment
Doc comment.
private
Doc|null
$doc_comment
Tags
$file
File.
private
SplFileInfo
$file
Tags
$tag
Tag.
private
string
$tag
Methods
__construct()
Construct hook.
public
__construct(SplFileInfo $file, FuncCall $call, Tag $tag[, array<string|int, Argument> $arguments = array() ]) : mixed
Parameters
- $file : SplFileInfo
-
File.
- $call : FuncCall
-
Function call.
- $tag : Tag
-
Tag.
- $arguments : array<string|int, Argument> = array()
-
Arguments.
Return values
mixed —get_arguments()
Arguments.
public
get_arguments() : array<string|int, mixed>
Return values
array<string|int, mixed> —get_call()
Get call.
public
get_call() : FuncCall
Return values
FuncCall —get_changelog()
Changelog.
public
get_changelog() : Changelog|null
Tags
Return values
Changelog|null —get_description()
Get description.
public
get_description() : string|null
Return values
string|null —get_doc_block()
Get doc block.
public
get_doc_block() : DocBlock|null
Return values
DocBlock|null —get_doc_comment()
Get doc comment.
public
get_doc_comment() : Doc|null
Return values
Doc|null —get_end_line()
Get end line.
public
get_end_line() : int
Return values
int —get_file()
Get file.
public
get_file() : SplFileInfo
Return values
SplFileInfo —get_since()
Get since.
public
get_since() : Since|null
Return values
Since|null —get_since_version()
Get since version.
public
get_since_version() : string|null
Return values
string|null —get_start_line()
Get start line.
public
get_start_line() : int
Return values
int —get_summary()
Get summary.
public
get_summary() : string|null
Return values
string|null —get_tag()
Get tag.
public
get_tag() : Tag
Return values
Tag —is_action()
Is action.
public
is_action() : bool
Return values
bool —True if is action, false otherwise.
is_deprecated()
Is deprecated.
public
is_deprecated() : bool
Return values
bool —True if is deprecated, false otherwise.
is_filter()
Is filter.
public
is_filter() : bool
Return values
bool —True if is filter, false otherwise.
set_changelog()
Set changelog.
public
set_changelog([Changelog|null $changelog = null ]) : mixed
Parameters
- $changelog : Changelog|null = null
-
Changelog.
Return values
mixed —set_doc_block()
Set doc block.
public
set_doc_block(DocBlock|null $doc_block) : void
Parameters
- $doc_block : DocBlock|null
-
Doc block.
Return values
void —set_doc_comment()
Set doc comment.
public
set_doc_comment([Doc|null $doc_comment = null ]) : mixed
Parameters
- $doc_comment : Doc|null = null
-
Doc comment.
Return values
mixed —tag()
Tag.
public
tag() : string