Overview

Namespaces

  • pgn
    • exceptions
    • tags
  • utils

Classes

  • Annotator
  • Black
  • BlackElo
  • BlackNA
  • BlackTitle
  • BlackType
  • BlackUSCF
  • Board
  • Date
  • ECO
  • Event
  • EventCountry
  • EventDate
  • EventRounds
  • EventSponsor
  • EventType
  • FEN
  • Mode
  • NIC
  • Opening
  • PlyCount
  • Result
  • Round
  • Section
  • SetUp
  • Site
  • Source
  • SourceDate
  • Stage
  • SubVariation
  • Tag
  • Termination
  • Time
  • TimeControl
  • UknownTag
  • UTCDate
  • UTCTime
  • Variation
  • White
  • WhiteElo
  • WhiteNA
  • WhiteTitle
  • WhiteType
  • WhiteUSCF
  • Overview
  • Namespace
  • Class

Class SetUp

Description of SetUp: This tag takes an integer that denotes the "set-up" status of the game. A value of "0" indicates that the game has started from the usual initial array. A value of "1" indicates that the game started from a set-up position; this position is given in the "FEN" tag pair. This tag must appear for a game starting with a set-up position. If it appears with a tag value of "1", a FEN tag pair must also appear.

pgn\tags\Tag
Extended by pgn\tags\SetUp
Namespace: pgn\tags
Author: Geraldo
See: pgn_standard.txt
Located at pgn/tags/SetUp.php
Methods summary
public the
# getName( )

Returns

the
name of the tag
public boolean
# validate( mixed $data )

Parameters

$data

Returns

boolean
returns if a data is valid

Assert("")

=== true

Assert("*")

=== false

Assert("-1")

=== false

Assert("0")

=== true

Assert("1")

=== true

Assert("2")

=== false

Assert("2.1")

=== false

Assert("a")

=== false

Assert(null)

=== false

Overrides

pgn\tags\Tag::validate()
public static string
# validPattern( )

Get the regex pattern of a valid SetUp tag string

Get the regex pattern of a valid SetUp tag string

Returns

string
regex pattern of a valid SetUp tag string

Overrides

pgn\tags\Tag::validPattern()
Methods inherited from pgn\tags\Tag
__toString(), createTag(), formatted(), get(), getDefaultValue(), parse(), parseTagName(), parseTagValue(), set()
Properties inherited from pgn\tags\Tag
$data, $errorMsg
API documentation generated by ApiGen