classRelationCursor

packages/sql-fixture/src/Plan/Parsing/RelationCursor.php:15

final class RelationCursor

Restricted visibility: declared "@visibility root". Code outside that scope must not name this declaration.

Tracks the unread position of one DBML relation statement.

Properties§

public string $source

source §

public int $offset = 0

source §

Methods§

public function __construct(public string $source, public int $offset = 0)

source §

Opens a statement at its first character.

Parameters

`$source`	`string`
`$offset`	`int`

public function readIdentifier(string $expected): string

source §

Consumes a quoted or unquoted identifier at the current cursor.

Parameters

$expected string

Returns

string

Throws

UnexpectedPlanTokenException

Test cases 2

Called from 4

Calls 4

function-call preg_match line 32
class-const RelationCursor::IDENTIFIER() line 32
new UnexpectedPlanTokenException line 33
function-call strlen line 36

public function readOperator(): RelationKind

source §

Consumes a supported relation operator.

Returns

RelationKind

Throws

UnexpectedPlanTokenException

Test cases 1

RelationCursorTest::testReadOperatorConsumesDirection calls

Called from 1

method-call SqlFixture\Plan\Parsing\RelationReader::parseStatement() packages/sql-fixture/src/Plan/Parsing/RelationReader.php:44

Calls 3

method-call RelationCursor::peek() line 53
static-call RelationKind::tryFrom() line 54
new UnexpectedPlanTokenException line 57

public function readOptionalMarker(): bool

source §

Consumes an optional endpoint marker when present.

Returns

bool

Test cases 1

RelationCursorTest::testReadOptionalMarkerLeavesUnmarkedInputAlone calls

Called from 2

Calls 1

method-call RelationCursor::peek() line 70

public function skipWhitespace(): void

source §

Advances the cursor past whitespace.

Test cases 1

RelationCursorTest::testSkipWhitespaceStopsBeforeIdentifier calls

Called from 6

Calls 2

method-call RelationCursor::peek() line 84
function-call trim line 84

public function expectEnd(): void

source §

Rejects trailing input after the relation statement.

Throws

UnexpectedPlanTokenException

Test cases 1

RelationCursorTest::testExpectEndAcceptsAnExhaustedStatement calls

Called from 2

Calls 2

function-call strlen line 95
new UnexpectedPlanTokenException line 96

public function peek(): ?string

source §

Reads the next character without advancing the cursor.

Returns

?string

Test cases 6

Called from 8

Private surface 1§

Implementation details, listed for orientation only.

private const IDENTIFIER = '/\G(?:`([^`]+)`|"([^"]+)"|([A-Za-z_][A-Za-z0-9_$]*))/'

Test cases 39§

Test cases that cover or call this symbol, from the coverage report and from the analyzed test sources.

Dedicated tests 6

Other tests reaching this symbol 33

PostgreSqlEndToEndTest calls
SqliteIntegrationTest calls
ConnectedTablesTest calls
OverrideSpecsTest calls
RelationCountsTest calls
RelationProjectionTest calls
RowMaterializerTest calls
GenerationRunTest calls
PlanGeneratorTest calls
PlanSchemaExceptionTest calls
PlanSchemaValidatorTest calls
EndpointValidatorTest calls
FixtureProviderTest calls
ConstructorHydrationTest calls
PropertyHydrationTest calls
ColumnRefTest calls
FixturePlanTest calls
PlanStatementsTest calls
RelationReaderTest::testBuildRelationsCarriesOptionalityToEachTarget calls
RelationReaderTest::testParseStatementExpandsGroupedTargets calls
RelationReaderTest::testReadEndpointPreservesQuotedIdentifiers calls
RelationReaderTest::testReadTargetsReadsACompositeEndpoint calls
PlanParserTest calls
PlanPrinterTest calls
PlanStructureExceptionTest calls
PlanSyntaxExceptionTest calls
PlanTablesTest calls
RelationGroupsTest calls
StatementPrinterTest calls
RelationTest calls
PlanValidationTest calls
TableNameTest calls
SqlSchemaProviderTest calls

Relations§

Instantiated in 1

new SqlFixture\Plan\PlanParser::parse() packages/sql-fixture/src/Plan/PlanParser.php:47

Method calls 20

Type declarations 1

type SqlFixture\Plan\Parsing\RelationReader packages/sql-fixture/src/Plan/Parsing/RelationReader.php:21