\Gettext\UtilsParsedComment

Comment parsed by PhpFunctionsScanner.

Summary

Methods

Properties

Constants

__construct()
create()
getFirstLine()
getLastLine()
getComment()
isRelatedWith()
checkPrefixes()

No public properties found

No constants found

No protected methods found

$comment
$firstLine
$lastLine

N/A

No private methods found

No private properties found

N/A

File: Gettext/Utils/ParsedComment.php
Package: Default
Class hierarchy: \Gettext\Utils\ParsedComment

Properties

$comment

$comment : string

The comment itself.

Type

string

$firstLine

$firstLine : integer

The line where the comment starts.

Type

integer

$lastLine

$lastLine : integer

The line where the comment ends.

Type

integer

Methods

__construct()

__construct(string  $comment, integer  $firstLine, integer  $lastLine)

Initializes the instance.

Parameters

string	$comment	The comment itself.
integer	$firstLine	The line where the comment starts.
integer	$lastLine	The line where the comment ends.

create()

create(string  $value, integer  $line) : self

Create new object from raw comment data.

Parameters

string	$value	The PHP comment string.
integer	$line	The line where the comment starts.

Returns

self —

The parsed comment.

getFirstLine()

getFirstLine() : integer

Return the line where the comment starts.

Returns

integer —

Line number.

getLastLine()

getLastLine() : integer

Return the line where the comment ends.

Returns

integer —

Line number.

getComment()

getComment() : string

Return the actual comment string.

Returns

string —

The comment.

isRelatedWith()

isRelatedWith(\Gettext\Utils\ParsedFunction  $function) : boolean

Whether this comment is related with a given function.

Parameters

\Gettext\Utils\ParsedFunction

$function

The function to check.

Returns

boolean —

Whether the comment is related or not.

checkPrefixes()

checkPrefixes(array  $prefixes) : boolean

Whether the comment matches the required prefixes.

Parameters

array

$prefixes

An array of prefixes to check.

Returns

boolean —

Whether the comment matches the prefixes or not.