SearchResult

class SearchResult extends AbstractObject implements IdAble

Properties

| | $lastQuery | | from AbstractObject |

Methods

__construct(AbstractClient $client, QueryBuilderChain $queryBuilderChain)

No description

from AbstractObject

null|array|string|int|float|bool

queryLeaf(QueryBuilder $leafQueryBuilder, string $leafKey)

No description

from AbstractObject

int

absoluteOffset()

The byte offset of this line within the file.

string

filePath()

The path to the file that matched.

AbstractId

id()

A unique identifier for this SearchResult.

int

lineNumber()

The first line that matched.

string

matchedLines()

The line content that matched.

array

submatches()

Sub-match positions and content within the matched lines.

Details

in AbstractObject at line 13 __construct(AbstractClient $client, QueryBuilderChain $queryBuilderChain)

No description

Parameters

| AbstractClient | $client | | | QueryBuilderChain | $queryBuilderChain | |

in AbstractObject at line 19 protected null|array|string|int|float|bool queryLeaf(QueryBuilder $leafQueryBuilder, string $leafKey)

No description

Parameters

| QueryBuilder | $leafQueryBuilder | | | string | $leafKey | |

Return Value

| null|array|string|int|float|bool | |

at line 16 int absoluteOffset()

The byte offset of this line within the file.

Return Value

| int | |

at line 25 string filePath()

The path to the file that matched.

Return Value

| string | |

at line 34 AbstractId id()

A unique identifier for this SearchResult.

Return Value

| AbstractId | |

at line 43 int lineNumber()

The first line that matched.

Return Value

| int | |

at line 52 string matchedLines()

The line content that matched.

Return Value

| string | |

at line 61 array submatches()

Sub-match positions and content within the matched lines.

Return Value

| array | |

Generated by Doctum, a API Documentation generator and fork of Sami.