---
title: WKT Parser 3.x
description: Installation, usage, return values and exceptions for LongitudeOne WKT Parser 3.x.
canonical_html: ./index.html
canonical_markdown: ./index.md
---

[View HTML version](./index.html)

> **Current version** — This documentation describes the current major version of `wkt-parser`.
> [View the library roadmap](../index.md)

Lexer and parser library for 2D, 3D, and 4D WKT/EWKT spatial object strings.

> **Note**
> This package is the continuation of the now abandoned [creof/wkt-parser](https://github.com/creof/wkt-parser) package.

## Installation

```bash
composer require longitude-one/wkt-parser:^3.0
```

## Usage

There are two use patterns for the parser. The value to be parsed can be passed into the constructor, then parse()
called on the returned `Parser` object:

```php
use LongitudeOne\Geo\WKT\Parser;

$input = 'POLYGON((0 0,10 0,10 10,0 10,0 0))';

$parser = new Parser($input);

$value = $parser->parse();
```

If many values need to be parsed, a single `Parser` instance can be used:

```php
use LongitudeOne\Geo\WKT\Parser;

$input1 = 'POLYGON((0 0,10 0,10 10,0 10,0 0))';
$input2 = 'POINT(0 0)';

$parser = new Parser();

$value1 = $parser->parse($input1);
$value2 = $parser->parse($input2);
```

## Return

The parser will return an array with the keys `type`, `value`, `srid`, and `dimension`.

- `type` string, the spatial object type (POINT, LINESTRING, etc.) without any dimension.
- `value` array, contains integer or float values for points, or nested arrays containing these based on spatial object type.
- `srid` integer, the SRID if EWKT value was parsed, `null` otherwise.
- `dimension` string, will contain `Z`, `M`, or `ZM` for the respective 3D and 4D objects, `null` otherwise.

## Exceptions

The `Lexer` and `Parser` will throw exceptions implementing interface `LongitudeOne\Geo\WKT\Exception\ExceptionInterface`.

## Related documentation

- [Library roadmap](../index.md)
- [Spatial formats](../../concepts/formats.md)