summaryrefslogtreecommitdiffstats
path: root/src/UtfString.php
diff options
context:
space:
mode:
Diffstat (limited to 'src/UtfString.php')
-rw-r--r--src/UtfString.php12
1 files changed, 12 insertions, 0 deletions
diff --git a/src/UtfString.php b/src/UtfString.php
index e98ee3f..bab15af 100644
--- a/src/UtfString.php
+++ b/src/UtfString.php
@@ -1,5 +1,17 @@
<?php
+/**
+ * Implementation for UTF-8 strings.
+ *
+ * The subscript operator in PHP, when used with string will return a byte
+ * and not a character. Because in UTF-8 strings a character may occupy more
+ * than one byte, the subscript operator may return an invalid character.
+ *
+ * Because the lexer relies on the subscript operator this class had to be
+ * implemented.
+ *
+ * @package SqlParser
+ */
namespace SqlParser;
/**