risendy/pgn-parser-bundle

There is no license information available for the latest version (v1.0.2) of this package.

Symfony Pgn Parser Bundle

v1.0.2 2021-02-02 15:26 UTC

Requires

• php: ^7.2.5
• ext-ctype: *
• ext-iconv: *

Requires (Dev)

• laminas/laminas-code: ^3.4
• symfony/phpunit-bridge: ^5.2

Unknown License

• Risendy

README

• General info
• Features
• Installation
• Usage
• Tests

General info

Simple symfony bundle for parsing pgn chess notations. PGN should be in string format, default tags delimiter is newline. There should be at least one blank line between tags and moves because it is used to process the pgn string.

Features

• extracting moves in string/json/array/object array formats
• getting specific moves (black or white)
• getting specific move comment
• getting first/last move
• extracting tags in string format
• getting tags value by name

Installation

composer require risendy/pgn-parser-bundle

Usage

To parse pgn string:

$game = new ChessParser();
$game->parsePgn($pgn);

To get moves in string format:

$moves = $game->getMovesString();

result:
string(15) "e4 e6 d4 d5 0-1"

To get moves in json format:

$json = $game->createJsonArray();

result:
{
   "tags":{
      "Event":"Lets Play!",
      "Site":"Chess.com",
      "Date":"2018.12.04",
      "Round":"?",
      "White":"guilherme_1910",
      "Black":"bmbio",
      "Result":"0-1",
      "TimeControl":"1\/259200:0"
   },
   "moves":[
      {
         "moveNumber":1,
         "white":"e4",
         "black":"e6"
      },
      {
         "moveNumber":2,
         "white":"d4",
         "black":null
      }
   ]
}

To get moves in array format:

$moves = $game->getSimpleMovesArray();

result:
array(5) {
  [0]=>
  string(2) "e4"
  [1]=>
  string(2) "e6"
  [2]=>
  string(2) "d4"
  [3]=>
  string(2) "d5"
  [4]=>
  string(3) "0-1"
}

To get moves in object array format:

$moves = $game->getObjectMovesArray();

result:
array(3) {
  [1]=>
  array(2) {
    [0]=>
    object(PgnParser\Move)#22 (3) {
      ["move":"PgnParser\Move":private]=>
      string(2) "e4"
      ["moveNumber":"PgnParser\Move":private]=>
      int(1)
      ["moveColor":"PgnParser\Move":private]=>
      string(1) "W"
    }
    [1]=>
    object(PgnParser\Move)#23 (3) {
      ["move":"PgnParser\Move":private]=>
      string(2) "e6"
      ["moveNumber":"PgnParser\Move":private]=>
      int(1)
      ["moveColor":"PgnParser\Move":private]=>
      string(1) "B"
    }
  }
  [2]=>
  array(2) {
    [0]=>
    object(PgnParser\Move)#24 (3) {
      ["move":"PgnParser\Move":private]=>
      string(2) "d4"
      ["moveNumber":"PgnParser\Move":private]=>
      int(2)
      ["moveColor":"PgnParser\Move":private]=>
      string(1) "W"
    }
    [1]=>
    object(PgnParser\Move)#25 (3) {
      ["move":"PgnParser\Move":private]=>
      string(2) "d5"
      ["moveNumber":"PgnParser\Move":private]=>
      int(2)
      ["moveColor":"PgnParser\Move":private]=>
      string(1) "B"
    }
  }
  [3]=>
  array(1) {
    [0]=>
    object(PgnParser\Move)#26 (3) {
      ["move":"PgnParser\Move":private]=>
      string(3) "0-1"
      ["moveNumber":"PgnParser\Move":private]=>
      int(3)
      ["moveColor":"PgnParser\Move":private]=>
      string(1) "W"
    }
  }
}

To get specific move instance:

$move = $game->getMove(2, 'B');

result:
object(PgnParser\Move)#75 (4) {
["san":"PgnParser\Move":private]=>
string(2) "d4"
["moveNumber":"PgnParser\Move":private]=>
int(2)
["moveColor":"PgnParser\Move":private]=>
string(1) "W"
["comment":"PgnParser\Move":private]=>
string(4) "test"

To get specific move san:

$move = $game->getMove(2, 'B')->getSan();

result:
string(2) "d5"

To get specific move comment:

$move = $game->getMove(2, 'B')->getComment();

result:
string(4) "test"

To get tag value by name:

$tagValue = $game->getTagValueByName('Black');

result:
string(5) "bmbio"

Tests

If you want to run tests there are in tests catalog.