diff options
author | Dan Ungureanu <udan1107@gmail.com> | 2015-06-26 14:25:19 +0300 |
---|---|---|
committer | Dan Ungureanu <udan1107@gmail.com> | 2015-06-26 14:25:19 +0300 |
commit | 20b6ec1a64c4ab74778a1049baba65de221835cb (patch) | |
tree | e22f0a63743fd7941c1549143aecf28c1d76e7e1 | |
parent | 13a0881dc9591b3fc3eb2386eb6fde0bfb194ea6 (diff) | |
download | sql-parser-20b6ec1a64c4ab74778a1049baba65de221835cb.zip sql-parser-20b6ec1a64c4ab74778a1049baba65de221835cb.tar.gz sql-parser-20b6ec1a64c4ab74778a1049baba65de221835cb.tar.bz2 |
Improved documentation.
60 files changed, 423 insertions, 67 deletions
diff --git a/src/Context.php b/src/Context.php index cbe666d..699d800 100644 --- a/src/Context.php +++ b/src/Context.php @@ -1,9 +1,17 @@ <?php +/** + * Defines a context class that is later extended to define other contexts. + * + * A context is a collection of keywords, operators and functions used for + * parsing. + * + * @package SqlParser + */ namespace SqlParser; /** - * Default MySQL context. + * Holds the configuration of the context that is currently used. * * @category Contexts * @package SqlParser diff --git a/src/Contexts/ContextMySql50000.php b/src/Contexts/ContextMySql50000.php index eedb59c..26afac1 100644 --- a/src/Contexts/ContextMySql50000.php +++ b/src/Contexts/ContextMySql50000.php @@ -3,9 +3,10 @@ /** * Context for MySQL 5. * - * @link https://dev.mysql.com/doc/refman/5.0/en/keywords.html + * @package SqlParser + * @subpackage Contexts + * @link https://dev.mysql.com/doc/refman/5.0/en/keywords.html */ - namespace SqlParser\Contexts; use SqlParser\Context; diff --git a/src/Contexts/ContextMySql50100.php b/src/Contexts/ContextMySql50100.php index 5f70976..23c619b 100644 --- a/src/Contexts/ContextMySql50100.php +++ b/src/Contexts/ContextMySql50100.php @@ -3,9 +3,10 @@ /** * Context for MySQL 5.1. * - * @link https://dev.mysql.com/doc/refman/5.1/en/keywords.html + * @package SqlParser + * @subpackage Contexts + * @link https://dev.mysql.com/doc/refman/5.1/en/keywords.html */ - namespace SqlParser\Contexts; use SqlParser\Context; diff --git a/src/Contexts/ContextMySql50500.php b/src/Contexts/ContextMySql50500.php index db53f5e..03105ab 100644 --- a/src/Contexts/ContextMySql50500.php +++ b/src/Contexts/ContextMySql50500.php @@ -3,9 +3,10 @@ /** * Context for MySQL 5.5. * - * @link https://dev.mysql.com/doc/refman/5.5/en/keywords.html + * @package SqlParser + * @subpackage Contexts + * @link https://dev.mysql.com/doc/refman/5.5/en/keywords.html */ - namespace SqlParser\Contexts; use SqlParser\Context; diff --git a/src/Contexts/ContextMySql50600.php b/src/Contexts/ContextMySql50600.php index 48fd6b2..91978cb 100644 --- a/src/Contexts/ContextMySql50600.php +++ b/src/Contexts/ContextMySql50600.php @@ -3,9 +3,10 @@ /** * Context for MySQL 5.6. * - * @link https://dev.mysql.com/doc/refman/5.6/en/keywords.html + * @package SqlParser + * @subpackage Contexts + * @link https://dev.mysql.com/doc/refman/5.6/en/keywords.html */ - namespace SqlParser\Contexts; use SqlParser\Context; diff --git a/src/Contexts/ContextMySql50700.php b/src/Contexts/ContextMySql50700.php index ac55a6c..0837409 100644 --- a/src/Contexts/ContextMySql50700.php +++ b/src/Contexts/ContextMySql50700.php @@ -3,9 +3,10 @@ /** * Context for MySQL 5.7. * - * @link https://dev.mysql.com/doc/refman/5.7/en/keywords.html + * @package SqlParser + * @subpackage Contexts + * @link https://dev.mysql.com/doc/refman/5.7/en/keywords.html */ - namespace SqlParser\Contexts; use SqlParser\Context; diff --git a/src/Exceptions/LexerException.php b/src/Exceptions/LexerException.php index 53327ed..886e662 100644 --- a/src/Exceptions/LexerException.php +++ b/src/Exceptions/LexerException.php @@ -1,5 +1,11 @@ <?php +/** + * Exception thrown by the lexer. + * + * @package SqlParser + * @subpackage Exceptions + */ namespace SqlParser\Exceptions; use SqlParser\Token; diff --git a/src/Exceptions/ParserException.php b/src/Exceptions/ParserException.php index 06a6033..5a9fac0 100644 --- a/src/Exceptions/ParserException.php +++ b/src/Exceptions/ParserException.php @@ -1,5 +1,11 @@ <?php +/** + * Exception thrown by the parser. + * + * @package SqlParser + * @subpackage Exceptions + */ namespace SqlParser\Exceptions; use SqlParser\Token; diff --git a/src/Fragment.php b/src/Fragment.php index 1c40699..a9a349a 100644 --- a/src/Fragment.php +++ b/src/Fragment.php @@ -1,5 +1,14 @@ <?php +/** + * Defines a fragment that is later extended to parse fragments or keywords. + * + * There is a small difference between *Fragment and *Keyword classes: usually, + * *Fragment parsers can be reused in multiple situations and *Keyword parsers + * count on the *Fragment classes to do their job. + * + * @package SqlParser + */ namespace SqlParser; /** diff --git a/src/Fragments/ArrayFragment.php b/src/Fragments/ArrayFragment.php index a713dde..7ed22ad 100644 --- a/src/Fragments/ArrayFragment.php +++ b/src/Fragments/ArrayFragment.php @@ -1,5 +1,11 @@ <?php +/** + * Parses an array. + * + * @package SqlParser + * @subpackage Fragments + */ namespace SqlParser\Fragments; use SqlParser\Fragment; diff --git a/src/Fragments/CallKeyword.php b/src/Fragments/CallKeyword.php index 4c1ed0c..ae3c467 100644 --- a/src/Fragments/CallKeyword.php +++ b/src/Fragments/CallKeyword.php @@ -1,5 +1,11 @@ <?php +/** + * Parses a function call. + * + * @package SqlParser + * @subpackage Fragments + */ namespace SqlParser\Fragments; use SqlParser\Fragment; diff --git a/src/Fragments/CreateDefFragment.php b/src/Fragments/CreateDefFragment.php index 58eabaa..403426c 100644 --- a/src/Fragments/CreateDefFragment.php +++ b/src/Fragments/CreateDefFragment.php @@ -1,5 +1,11 @@ <?php +/** + * Parses the definition that follows the `CREATE` keyword. + * + * @package SqlParser + * @subpackage Fragments + */ namespace SqlParser\Fragments; use SqlParser\Fragment; diff --git a/src/Fragments/DataTypeFragment.php b/src/Fragments/DataTypeFragment.php index a8045cf..2ad700a 100644 --- a/src/Fragments/DataTypeFragment.php +++ b/src/Fragments/DataTypeFragment.php @@ -1,5 +1,11 @@ <?php +/** + * Parses a data type. + * + * @package SqlParser + * @subpackage Fragments + */ namespace SqlParser\Fragments; use SqlParser\Context; diff --git a/src/Fragments/FieldDefFragment.php b/src/Fragments/FieldDefFragment.php index 20983e9..d38eeda 100644 --- a/src/Fragments/FieldDefFragment.php +++ b/src/Fragments/FieldDefFragment.php @@ -1,5 +1,13 @@ <?php +/** + * Parses the definition of a field. + * + * Used for parsing `CREATE TABLE` statement. + * + * @package SqlParser + * @subpackage Fragments + */ namespace SqlParser\Fragments; use SqlParser\Context; diff --git a/src/Fragments/FieldFragment.php b/src/Fragments/FieldFragment.php index 4a0c2ca..5140324 100644 --- a/src/Fragments/FieldFragment.php +++ b/src/Fragments/FieldFragment.php @@ -1,5 +1,11 @@ <?php +/** + * Parses a reference to a field. + * + * @package SqlParser + * @subpackage Fragments + */ namespace SqlParser\Fragments; use SqlParser\Fragment; diff --git a/src/Fragments/FromKeyword.php b/src/Fragments/FromKeyword.php index aea9c3e..6fbf0ba 100644 --- a/src/Fragments/FromKeyword.php +++ b/src/Fragments/FromKeyword.php @@ -1,5 +1,11 @@ <?php +/** + * `FROM` keyword parser. + * + * @package SqlParser + * @subpackage Fragments + */ namespace SqlParser\Fragments; use SqlParser\Fragment; diff --git a/src/Fragments/IntoKeyword.php b/src/Fragments/IntoKeyword.php index f5c9592..558b3e6 100644 --- a/src/Fragments/IntoKeyword.php +++ b/src/Fragments/IntoKeyword.php @@ -1,5 +1,11 @@ <?php +/** + * `INTO` keyword parser. + * + * @package SqlParser + * @subpackage Fragments + */ namespace SqlParser\Fragments; use SqlParser\Fragment; diff --git a/src/Fragments/JoinKeyword.php b/src/Fragments/JoinKeyword.php index b6b2c22..011bd4d 100644 --- a/src/Fragments/JoinKeyword.php +++ b/src/Fragments/JoinKeyword.php @@ -1,5 +1,11 @@ <?php +/** + * `JOIN` keyword parser. + * + * @package SqlParser + * @subpackage Fragments + */ namespace SqlParser\Fragments; use SqlParser\Fragment; diff --git a/src/Fragments/KeyFragment.php b/src/Fragments/KeyFragment.php index e1ac679..4a71857 100644 --- a/src/Fragments/KeyFragment.php +++ b/src/Fragments/KeyFragment.php @@ -1,5 +1,11 @@ <?php +/** + * Parses the definition of a key. + * + * @package SqlParser + * @subpackage Fragments + */ namespace SqlParser\Fragments; use SqlParser\Context; diff --git a/src/Fragments/LimitKeyword.php b/src/Fragments/LimitKeyword.php index 1e4ae4f..261ef3e 100644 --- a/src/Fragments/LimitKeyword.php +++ b/src/Fragments/LimitKeyword.php @@ -1,5 +1,11 @@ <?php +/** + * `lIMIT` keyword parser. + * + * @package SqlParser + * @subpackage Fragments + */ namespace SqlParser\Fragments; use SqlParser\Fragment; diff --git a/src/Fragments/OptionsFragment.php b/src/Fragments/OptionsFragment.php index dbd3676..54d4857 100644 --- a/src/Fragments/OptionsFragment.php +++ b/src/Fragments/OptionsFragment.php @@ -1,5 +1,11 @@ <?php +/** + * Parses a list of options. + * + * @package SqlParser + * @subpackage Fragments + */ namespace SqlParser\Fragments; use SqlParser\Fragment; @@ -124,7 +130,7 @@ class OptionsFragment extends Fragment /** * Checks if it has the specified option and returns it value or true. * - * @param string $key + * @param string $key The key to be checked. * * @return mixed */ @@ -144,7 +150,7 @@ class OptionsFragment extends Fragment * Merges the specified options with these ones. Values with same ID will be * replaced. * - * @param array|OptionsFragment $options + * @param array|OptionsFragment $options The options to be merged. * * @return void */ diff --git a/src/Fragments/OrderKeyword.php b/src/Fragments/OrderKeyword.php index 34744e3..5194208 100644 --- a/src/Fragments/OrderKeyword.php +++ b/src/Fragments/OrderKeyword.php @@ -1,5 +1,11 @@ <?php +/** + * `ORDER BY` keyword parser. + * + * @package SqlParser + * @subpackage Fragments + */ namespace SqlParser\Fragments; use SqlParser\Fragment; diff --git a/src/Fragments/ParamDefFragment.php b/src/Fragments/ParamDefFragment.php index 4756120..a512596 100644 --- a/src/Fragments/ParamDefFragment.php +++ b/src/Fragments/ParamDefFragment.php @@ -1,5 +1,11 @@ <?php +/** + * The definition of a parameter of a function or procedure. + * + * @package SqlParser + * @subpackage Fragments + */ namespace SqlParser\Fragments; use SqlParser\Context; diff --git a/src/Fragments/ReferencesKeyword.php b/src/Fragments/ReferencesKeyword.php index 939eb24..d4afd01 100644 --- a/src/Fragments/ReferencesKeyword.php +++ b/src/Fragments/ReferencesKeyword.php @@ -1,5 +1,11 @@ <?php +/** + * `REFERENCES` keyword parser. + * + * @package SqlParser + * @subpackage Fragments + */ namespace SqlParser\Fragments; use SqlParser\Fragment; diff --git a/src/Fragments/RenameKeyword.php b/src/Fragments/RenameKeyword.php index 9e9969c..980ad7b 100644 --- a/src/Fragments/RenameKeyword.php +++ b/src/Fragments/RenameKeyword.php @@ -1,5 +1,11 @@ <?php +/** + * `RENAME TABLE` keyword parser. + * + * @package SqlParser + * @subpackage Fragments + */ namespace SqlParser\Fragments; use SqlParser\Fragment; diff --git a/src/Fragments/SelectKeyword.php b/src/Fragments/SelectKeyword.php index fc59aa0..5cf4719 100644 --- a/src/Fragments/SelectKeyword.php +++ b/src/Fragments/SelectKeyword.php @@ -1,5 +1,11 @@ <?php +/** + * `SELECT` keyword parser. + * + * @package SqlParser + * @subpackage Fragments + */ namespace SqlParser\Fragments; use SqlParser\Fragment; diff --git a/src/Fragments/SetKeyword.php b/src/Fragments/SetKeyword.php index 82f9965..547768c 100644 --- a/src/Fragments/SetKeyword.php +++ b/src/Fragments/SetKeyword.php @@ -1,5 +1,11 @@ <?php +/** + * `SET` keyword parser. + * + * @package SqlParser + * @subpackage Fragments + */ namespace SqlParser\Fragments; use SqlParser\Fragment; diff --git a/src/Fragments/ValuesKeyword.php b/src/Fragments/ValuesKeyword.php index cb470dd..6977f68 100644 --- a/src/Fragments/ValuesKeyword.php +++ b/src/Fragments/ValuesKeyword.php @@ -1,5 +1,11 @@ <?php +/** + * `VALUES` keyword parser. + * + * @package SqlParser + * @subpackage Fragments + */ namespace SqlParser\Fragments; use SqlParser\Fragment; diff --git a/src/Fragments/WhereKeyword.php b/src/Fragments/WhereKeyword.php index 0bc60a7..1b36cc8 100644 --- a/src/Fragments/WhereKeyword.php +++ b/src/Fragments/WhereKeyword.php @@ -1,5 +1,11 @@ <?php +/** + * `WHERE` keyword parser. + * + * @package SqlParser + * @subpackage Fragments + */ namespace SqlParser\Fragments; use SqlParser\Fragment; diff --git a/src/Lexer.php b/src/Lexer.php index 33e7337..d681425 100644 --- a/src/Lexer.php +++ b/src/Lexer.php @@ -1,5 +1,14 @@ <?php +/** + * Defines the lexer of the library. + * + * This is one of the most important components, along with the parser. + * + * Depends on context to extract lexemes. + * + * @package SqlParser + */ namespace SqlParser; use SqlParser\Exceptions\LexerException; diff --git a/src/Parser.php b/src/Parser.php index ba0a144..a2f7ef7 100644 --- a/src/Parser.php +++ b/src/Parser.php @@ -1,5 +1,12 @@ <?php +/** + * Defines the parser of the library. + * + * This is one of the most important components, along with the lexer. + * + * @package SqlParser + */ namespace SqlParser; use SqlParser\Exceptions\ParserException; @@ -286,6 +293,8 @@ class Parser * @param string $msg The error message. * @param Token $token The token that produced the error. * @param int $code The code of the error. + * + * @return void */ public function error($msg = '', Token $token = null, $code = 0) { diff --git a/src/Statement.php b/src/Statement.php index 1b7e590..a813fff 100644 --- a/src/Statement.php +++ b/src/Statement.php @@ -1,5 +1,13 @@ <?php +/** + * The result of the parser is an array of statements are extensions of the + * class defined here. + * + * A statement represents the result of parsing the lexemes. + * + * @package SqlParser. + */ namespace SqlParser; use SqlParser\Parser; @@ -132,9 +140,9 @@ abstract class Statement /** * Function called before the token was processed. * - * @param Parser $parser The instance that requests parsing. - * @param TokensList $list The list of tokens to be parsed. - * @param Token $token The token that is being parsed. + * @param Parser $parser The instance that requests parsing. + * @param TokensList $list The list of tokens to be parsed. + * @param Token $token The token that is being parsed. * * @return void */ @@ -146,11 +154,11 @@ abstract class Statement /** * Function called after the token was processed. * - * @param Parser $parser The instance that requests parsing. - * @param TokensList $list The list of tokens to be parsed. - * @param Token $token The token that is being parsed. + * @param Parser $parser The instance that requests parsing. + * @param TokensList $list The list of tokens to be parsed. + * @param Token $token The token that is being parsed. * - * @return + * @return void */ public function after(Parser $parser, TokensList $list, Token $token) { diff --git a/src/Statements/AlterStatement.php b/src/Statements/AlterStatement.php index 4cc29cd..1d6b44c 100644 --- a/src/Statements/AlterStatement.php +++ b/src/Statements/AlterStatement.php @@ -1,5 +1,11 @@ <?php +/** + * `ALTER` statement. + * + * @package SqlParser + * @subpackage Statements + */ namespace SqlParser\Statements; use SqlParser\Statements\NotImplementedStatement; diff --git a/src/Statements/AnalyzeStatement.php b/src/Statements/AnalyzeStatement.php index 78783f2..850a27a 100644 --- a/src/Statements/AnalyzeStatement.php +++ b/src/Statements/AnalyzeStatement.php @@ -1,5 +1,11 @@ <?php +/** + * `ANALYZE` statement. + * + * @package SqlParser + * @subpackage Statements + */ namespace SqlParser\Statements; use SqlParser\Statement; diff --git a/src/Statements/BackupStatement.php b/src/Statements/BackupStatement.php index cc2e07e..c8e0977 100644 --- a/src/Statements/BackupStatement.php +++ b/src/Statements/BackupStatement.php @@ -1,5 +1,11 @@ <?php +/** + * `BACKUP` statement. + * + * @package SqlParser + * @subpackage Statements + */ namespace SqlParser\Statements; use SqlParser\Statements\MaintenanceStatement; diff --git a/src/Statements/CallStatement.php b/src/Statements/CallStatement.php index 162f50e..0e83282 100644 --- a/src/Statements/CallStatement.php +++ b/src/Statements/CallStatement.php @@ -1,5 +1,11 @@ <?php +/** + * `CALL` statement. + * + * @package SqlParser + * @subpackage Statements + */ namespace SqlParser\Statements; use SqlParser\Statement; diff --git a/src/Statements/CheckStatement.php b/src/Statements/CheckStatement.php index 4619613..38764ff 100644 --- a/src/Statements/CheckStatement.php +++ b/src/Statements/CheckStatement.php @@ -1,5 +1,11 @@ <?php +/** + * `CHECK` statement. + * + * @package SqlParser + * @subpackage Statements + */ namespace SqlParser\Statements; use SqlParser\Statements\MaintenanceStatement; diff --git a/src/Statements/ChecsumStatement.php b/src/Statements/ChecsumStatement.php index 36426d2..e2c6371 100644 --- a/src/Statements/ChecsumStatement.php +++ b/src/Statements/ChecsumStatement.php @@ -1,5 +1,11 @@ <?php +/** + * `CHECKSUM` statement. + * + * @package SqlParser + * @subpackage Statements + */ namespace SqlParser\Statements; use SqlParser\Statements\MaintenanceStatement; diff --git a/src/Statements/CreateStatement.php b/src/Statements/CreateStatement.php index b5d56fe..ef11537 100644 --- a/src/Statements/CreateStatement.php +++ b/src/Statements/CreateStatement.php @@ -1,10 +1,16 @@ <?php +/** + * `CREATE` statement. + * + * @package SqlParser + * @subpackage Statements + */ namespace SqlParser\Statements; use SqlParser\Parser; use SqlParser\Statement; -use sqlParser\Token; +use SqlParser\Token; use SqlParser\TokensList; use SqlParser\Fragments\CreateDefFragment; use SqlParser\Fragments\DataTypeFragment; @@ -96,9 +102,9 @@ class CreateStatement extends Statement /** * Parsing the `CREATE` statement. * - * @param Parser $parser The instance that requests parsing. - * @param TokensList $list The list of tokens to be parsed. - * @param Token $token The token that is being parsed. + * @param Parser $parser The instance that requests parsing. + * @param TokensList $list The list of tokens to be parsed. + * @param Token $token The token that is being parsed. * * @return void */ diff --git a/src/Statements/DeleteStatement.php b/src/Statements/DeleteStatement.php index e7f3a69..9016da3 100644 --- a/src/Statements/DeleteStatement.php +++ b/src/Statements/DeleteStatement.php @@ -1,5 +1,11 @@ <?php +/** + * `DELETE` statement. + * + * @package SqlParser + * @subpackage Statements + */ namespace SqlParser\Statements; use SqlParser\Statement; diff --git a/src/Statements/DropStatement.php b/src/Statements/DropStatement.php index de96de7..716ca54 100644 --- a/src/Statements/DropStatement.php +++ b/src/Statements/DropStatement.php @@ -1,5 +1,11 @@ <?php +/** + * `DROP` statement. + * + * @package SqlParser + * @subpackage Statements + */ namespace SqlParser\Statements; use SqlParser\Statement; diff --git a/src/Statements/ExplainStatement.php b/src/Statements/ExplainStatement.php index 8670b08..2a34b0d 100644 --- a/src/Statements/ExplainStatement.php +++ b/src/Statements/ExplainStatement.php @@ -1,5 +1,11 @@ <?php +/** + * `EXPLAIN` statement. + * + * @package SqlParser + * @subpackage Statements + */ namespace SqlParser\Statements; use SqlParser\Statements\NotImplementedStatement; diff --git a/src/Statements/InsertStatement.php b/src/Statements/InsertStatement.php index c80e194..385e4bf 100644 --- a/src/Statements/InsertStatement.php +++ b/src/Statements/InsertStatement.php @@ -1,5 +1,11 @@ <?php +/** + * `INSERT` statement. + * + * @package SqlParser + * @subpackage Statements + */ namespace SqlParser\Statements; use SqlParser\Statement; diff --git a/src/Statements/MaintenanceStatement.php b/src/Statements/MaintenanceStatement.php index b26e1c0..a0df634 100644 --- a/src/Statements/MaintenanceStatement.php +++ b/src/Statements/MaintenanceStatement.php @@ -1,15 +1,21 @@ <?php +/** + * Maintenance statement. + * + * @package SqlParser + * @subpackage Statements + */ namespace SqlParser\Statements; use SqlParser\Parser; use SqlParser\Statement; -use sqlParser\Token; +use SqlParser\Token; use SqlParser\TokensList; use SqlParser\Fragments\OptionsFragment; /** - * Maintenance statements. + * Maintenance statement. * * They follow the syntax: * STMT [some options] tbl_name [, tbl_name] ... [some more options] @@ -33,11 +39,11 @@ class MaintenanceStatement extends Statement /** * Parses the additional options fragment at the end. * - * @param Parser $parser The instance that requests parsing. - * @param TokensList $list The list of tokens to be parsed. - * @param Token $token The token that is being parsed. + * @param Parser $parser The instance that requests parsing. + * @param TokensList $list The list of tokens to be parsed. + * @param Token $token The token that is being parsed. * - * @return + * @return void */ public function after(Parser $parser, TokensList $list, Token $token) { diff --git a/src/Statements/NotImplementedStatement.php b/src/Statements/NotImplementedStatement.php index 9f9f61c..1ad5cc5 100644 --- a/src/Statements/NotImplementedStatement.php +++ b/src/Statements/NotImplementedStatement.php @@ -1,10 +1,16 @@ <?php +/** + * Not implemented (yet) statements. + * + * @package SqlParser + * @subpackage Statements + */ namespace SqlParser\Statements; use SqlParser\Parser; use SqlParser\Statement; -use sqlParser\Token; +use SqlParser\Token; use SqlParser\TokensList; /** @@ -24,11 +30,11 @@ class NotImplementedStatement extends Statement /** * Jump to the end of the delimiter. * - * @param Parser $parser The instance that requests parsing. - * @param TokensList $list The list of tokens to be parsed. - * @param Token $token The token that is being parsed. + * @param Parser $parser The instance that requests parsing. + * @param TokensList $list The list of tokens to be parsed. + * @param Token $token The token that is being parsed. * - * @return + * @return void */ public function before(Parser $parser, TokensList $list, Token $token) { diff --git a/src/Statements/OptimizeStatement.php b/src/Statements/OptimizeStatement.php index 0b7b38a..f163b87 100644 --- a/src/Statements/OptimizeStatement.php +++ b/src/Statements/OptimizeStatement.php @@ -1,5 +1,11 @@ <?php +/** + * `OPTIMIZE` statement. + * + * @package SqlParser + * @subpackage Statements + */ namespace SqlParser\Statements; use SqlParser\Statement; diff --git a/src/Statements/RenameStatement.php b/src/Statements/RenameStatement.php index 0f5a1c7..5ebd2fa 100644 --- a/src/Statements/RenameStatement.php +++ b/src/Statements/RenameStatement.php @@ -1,10 +1,16 @@ <?php +/** + * `RENAME` statement. + * + * @package SqlParser + * @subpackage Statements + */ namespace SqlParser\Statements; use SqlParser\Parser; use SqlParser\Statement; -use sqlParser\Token; +use SqlParser\Token; use SqlParser\TokensList; /** @@ -32,9 +38,9 @@ class RenameStatement extends Statement /** * Skips the `TABLE` keyword after `RENAME`. * - * @param Parser $parser The instance that requests parsing. - * @param TokensList $list The list of tokens to be parsed. - * @param Token $token The token that is being parsed. + * @param Parser $parser The instance that requests parsing. + * @param TokensList $list The list of tokens to be parsed. + * @param Token $token The token that is being parsed. * * @return void */ diff --git a/src/Statements/RepairStatement.php b/src/Statements/RepairStatement.php index d4053ee..933d2c0 100644 --- a/src/Statements/RepairStatement.php +++ b/src/Statements/RepairStatement.php @@ -1,5 +1,11 @@ <?php +/** + * `REPAIR` statement. + * + * @package SqlParser + * @subpackage Statements + */ namespace SqlParser\Statements; use SqlParser\Statements\MaintenanceStatement; diff --git a/src/Statements/ReplaceStatement.php b/src/Statements/ReplaceStatement.php index 0411f45..8df7cb4 100644 --- a/src/Statements/ReplaceStatement.php +++ b/src/Statements/ReplaceStatement.php @@ -1,5 +1,11 @@ <?php +/** + * `REPLACE` statement. + * + * @package SqlParser + * @subpackage Statements + */ namespace SqlParser\Statements; use SqlParser\Statement; diff --git a/src/Statements/RestoreStatement.php b/src/Statements/RestoreStatement.php index 89e2ed5..996b41e 100644 --- a/src/Statements/RestoreStatement.php +++ b/src/Statements/RestoreStatement.php @@ -1,5 +1,11 @@ <?php +/** + * `RESTORE` statement. + * + * @package SqlParser + * @subpackage Statements + */ namespace SqlParser\Statements; use SqlParser\Statements\MaintenanceStatement; diff --git a/src/Statements/SelectStatement.php b/src/Statements/SelectStatement.php index 4b9584f..8cdee82 100644 --- a/src/Statements/SelectStatement.php +++ b/src/Statements/SelectStatement.php @@ -1,5 +1,11 @@ <?php +/** + * `SELECT` statement. + * + * @package SqlParser + * @subpackage Statements + */ namespace SqlParser\Statements; use SqlParser\Statement; diff --git a/src/Statements/ShowStatement.php b/src/Statements/ShowStatement.php index 57a4110..02da79d 100644 --- a/src/Statements/ShowStatement.php +++ b/src/Statements/ShowStatement.php @@ -1,5 +1,11 @@ <?php +/** + * `SHOW` statement. + * + * @package SqlParser + * @subpackage Statements + */ namespace SqlParser\Statements; use SqlParser\Statements\NotImplementedStatement; diff --git a/src/Statements/UpdateStatement.php b/src/Statements/UpdateStatement.php index 39a0f1c..d100560 100644 --- a/src/Statements/UpdateStatement.php +++ b/src/Statements/UpdateStatement.php @@ -1,5 +1,11 @@ <?php +/** + * `UPDATE` statement. + * + * @package SqlParser + * @subpackage Statements + */ namespace SqlParser\Statements; use SqlParser\Statement; diff --git a/src/Token.php b/src/Token.php index 160efcd..fa23d28 100644 --- a/src/Token.php +++ b/src/Token.php @@ -1,5 +1,12 @@ <?php +/** + * Defines a token along with a set of types and flags and utility functions. + * + * An array of tokens will result after parsing the query. + * + * @package SqlParser + */ namespace SqlParser; /** diff --git a/src/TokensList.php b/src/TokensList.php index 533fb0b..6365be6 100644 --- a/src/TokensList.php +++ b/src/TokensList.php @@ -1,5 +1,10 @@ <?php +/** + * Defines an array of tokens and utility functions to iterate through it. + * + * @package SqlParser + */ namespace SqlParser; /** 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; /** diff --git a/src/Utils/Misc.php b/src/Utils/Misc.php index 55ae33b..85c2399 100644 --- a/src/Utils/Misc.php +++ b/src/Utils/Misc.php @@ -1,5 +1,11 @@ <?php +/** + * Miscellaneous utilities. + * + * @package SqlParser + * @subpackage Utils + */ namespace SqlParser\Utils; use SqlParser\Statement; @@ -20,14 +26,14 @@ class Misc /** * Gets a list of all aliases and their original names. * - * @param SelectStatement $tree The tree that was generated after parsing. - * @param string $database The name of the database. + * @param SelectStatement $statement The statement to be processed. + * @param string $database The name of the database. * * @return array */ - public static function getAliases($tree, $database) + public static function getAliases($statement, $database) { - if ((empty($tree->from)) || (empty($tree->expr))) { + if ((empty($statement->from)) || (empty($statement->expr))) { return array(); } @@ -35,28 +41,28 @@ class Misc $tables = array(); - if ((!empty($tree->join->expr->table)) - && (!empty($tree->join->expr->alias)) + if ((!empty($statement->join->expr->table)) + && (!empty($statement->join->expr->alias)) ) { - $thisDb = empty($tree->join->expr->database) ? - $database : $tree->join->expr->database; + $thisDb = empty($statement->join->expr->database) ? + $database : $statement->join->expr->database; $retval = array( $thisDb => array( 'alias' => null, 'tables' => array( - $tree->join->expr->table => array( - 'alias' => $tree->join->expr->alias, + $statement->join->expr->table => array( + 'alias' => $statement->join->expr->alias, 'columns' => array(), ), ), ), ); - $tables[$thisDb][$tree->join->expr->alias] = $tree->join->expr->table; + $tables[$thisDb][$statement->join->expr->alias] = $statement->join->expr->table; } - foreach ($tree->from as $expr) { + foreach ($statement->from as $expr) { if (empty($expr->table)) { continue; } @@ -83,7 +89,7 @@ class Misc $tables[$thisDb][$expr->alias] = $expr->table; } - foreach ($tree->expr as $expr) { + foreach ($statement->expr as $expr) { if ((empty($expr->column)) || (empty($expr->alias))) { continue; } diff --git a/src/Utils/Query.php b/src/Utils/Query.php index c308344..b1a95b1 100644 --- a/src/Utils/Query.php +++ b/src/Utils/Query.php @@ -1,5 +1,11 @@ <?php +/** + * Statement utilities. + * + * @package SqlParser + * @subpackage Utils + */ namespace SqlParser\Utils; use SqlParser\Parser; @@ -45,8 +51,8 @@ class Query /** * Gets an array with flags this statement has. * - * @param Statement $statement - * @param bool $all If `false`, false values will not be included. + * @param Statement $statement The statement to be processed. + * @param bool $all If `false`, false values will not be included. * * @return array */ @@ -164,7 +170,7 @@ class Query /** * Parses a query and gets all information about it. * - * @param string $query + * @param string $query The query to be parsed. * * @return array */ diff --git a/src/Utils/Routine.php b/src/Utils/Routine.php index 76d3d71..4b9b21d 100644 --- a/src/Utils/Routine.php +++ b/src/Utils/Routine.php @@ -1,5 +1,11 @@ <?php +/** + * Routine utilities. + * + * @package SqlParser + * @subpackage Utils + */ namespace SqlParser\Utils; use SqlParser\Lexer; @@ -90,11 +96,11 @@ class Routine /** * Gets the parameters of a routine from the parse tree. * - * @param CreateStatement $tree The tree that was generated after parsing. + * @param CreateStatement $statement The statement to be processed. * * @return array */ - public static function getParameters($tree) + public static function getParameters($statement) { $retval = array( 'num' => 0, @@ -106,9 +112,9 @@ class Routine 'opts' => array(), ); - if (!empty($tree->parameters)) { + if (!empty($statement->parameters)) { $idx = 0; - foreach ($tree->parameters as $param) { + foreach ($statement->parameters as $param) { $retval['dir'][$idx] = $param->inOut; $retval['name'][$idx] = $param->name; $retval['type'][$idx] = $param->type->name; diff --git a/src/Utils/Table.php b/src/Utils/Table.php index 6bc83a5..95b6850 100644 --- a/src/Utils/Table.php +++ b/src/Utils/Table.php @@ -1,5 +1,11 @@ <?php +/** + * Table utilities. + * + * @package SqlParser + * @subpackage Utils + */ namespace SqlParser\Utils; use SqlParser\Lexer; @@ -24,19 +30,19 @@ class Table /** * Gets the foreign keys of the table. * - * @param CreateStatement $tree + * @param CreateStatement $statement The statement to be processed. * * @return array */ - public static function getForeignKeys($tree) + public static function getForeignKeys($statement) { - if ((empty($tree->fields)) || (!$tree->options->has('TABLE'))) { + if ((empty($statement->fields)) || (!$statement->options->has('TABLE'))) { return array(); } $ret = array(); - foreach ($tree->fields as $field) { + foreach ($statement->fields as $field) { if ((empty($field->key)) || ($field->key->type !== 'FOREIGN KEY')) { continue; @@ -74,19 +80,19 @@ class Table /** * Gets fields of the table. * - * @param CreateStatement $tree + * @param CreateStatement $statement The statement to be processed. * * @return array */ - public static function getFields($tree) + public static function getFields($statement) { - if ((empty($tree->fields)) || (!$tree->options->has('TABLE'))) { + if ((empty($statement->fields)) || (!$statement->options->has('TABLE'))) { return array(); } $ret = array(); - foreach ($tree->fields as $field) { + foreach ($statement->fields as $field) { // Skipping keys. if (empty($field->type)) { |