update docblocks

auraphp · Jan 23, 2017 · f054d65 · f054d65
1 parent b7f3dbf
commit f054d65
Show file tree

Hide file tree

Showing 10 changed files with 119 additions and 35 deletions.
diff --git a/src/AbstractExtendedPdo.php b/src/AbstractExtendedPdo.php
@@ -383,11 +383,25 @@ public function fetchValue($statement, array $values = [])
         return $sth->fetchColumn(0);
     }
 
+    /**
+     *
+     * Returns the Parser instance.
+     *
+     * @return ParserInterface
+     *
+     */
     public function getParser()
     {
         return $this->parser;
     }
 
+    /**
+     *
+     * Returns the Profiler instance.
+     *
+     * @return ProfilerInterface
+     *
+     */
     public function getProfiler()
     {
         return $this->profiler;
@@ -416,7 +430,7 @@ public function inTransaction()
      * Returns the last inserted autoincrement sequence value.
      *
      * @param string $name The name of the sequence to check; typically needed
-     *                     only for PostgreSQL, where it takes the form of `<table>_<column>_seq`.
+     * only for PostgreSQL, where it takes the form of `<table>_<column>_seq`.
      *
      * @return string
      *
@@ -600,16 +614,23 @@ public function rollBack()
 
     /**
      *
-     * Registers a query parser
+     * Sets the Parser instance.
      *
-     * @param ParserInterface $parser
+     * @param ParserInterface $parser The Parser instance.
      *
      */
     public function setParser(ParserInterface $parser)
     {
         $this->parser = $parser;
     }
 
+    /**
+     *
+     * Sets the Profiler instance.
+     *
+     * @param ProfilerInterface $profiler The Profiler instance.
+     *
+     */
     public function setProfiler(ProfilerInterface $profiler)
     {
         $this->profiler = $profiler;

diff --git a/src/ExtendedPdo.php b/src/ExtendedPdo.php
@@ -44,7 +44,7 @@ class ExtendedPdo extends AbstractExtendedPdo
      *
      * @param array $options Driver-specific options for the connection.
      *
-     * @param array $attributes Attributes to set after the connection.
+     * @param array $queries Queries to execute after the connection.
      *
      * @param ProfilerInterface $profiler Tracks and logs query profiles.
      *

diff --git a/src/ExtendedPdoInterface.php b/src/ExtendedPdoInterface.php
@@ -243,7 +243,7 @@ public function setParser(ParserInterface $parser);
      *
      * Sets the Profiler instance.
      *
-     * @param ProfilerInterface $profiler The profiler instance.
+     * @param ProfilerInterface $profiler The Profiler instance.
      *
      */
     public function setProfiler(ProfilerInterface $profiler);

diff --git a/src/Parser/AbstractParser.php b/src/Parser/AbstractParser.php
@@ -21,10 +21,16 @@ abstract class AbstractParser implements ParserInterface
 {
     /**
      *
-     * List of handlers to call when a character is found.
+     * The character set to use when parsing query statements.
      *
-     * The key is the character, the value is a method name which takes a State
-     * as parameter and returns a State.
+     * @var string
+     *
+     */
+    protected $charset = 'UTF-8';
+
+    /**
+     *
+     * Map of characters to handler methods.
      *
      * @var array
      *
@@ -40,8 +46,14 @@ abstract class AbstractParser implements ParserInterface
      */
     protected $numberedPlaceHolderCharacter = "?";
 
-    protected $charset = 'UTF-8';
-
+    /**
+     *
+     * Constructor.
+     *
+     * @param string $charset The character set to use when parsing query
+     * statements.
+     *
+     */
     public function __construct($charset = 'UTF-8')
     {
         $this->charset = $charset;
@@ -62,10 +74,14 @@ public function __construct($charset = 'UTF-8')
     public function rebuild($statement, array $values = [])
     {
         $query = new Query($statement, $values);
-        $queries = array();
 
-        /** @var State $state */
-        $state = new State($query->getStatement(), $query->getValues(), $this->charset);
+        $queries = [];
+
+        $state = new State(
+            $query->getStatement(),
+            $query->getValues(),
+            $this->charset
+        );
 
         $last_check_index = -1;
 
@@ -103,7 +119,7 @@ public function rebuild($statement, array $values = [])
      * @param Query[] $queries reference to the array holding a list of queries.
      *
      */
-    private function storeQuery($state, &$queries)
+    private function storeQuery(State $state, &$queries)
     {
         $statement = $state->getFinalStatement();
         if (! $this->isStatementEmpty($statement)) {
@@ -127,12 +143,13 @@ private function isStatementEmpty($statement)
 
     /**
      *
-     * After a single or double quote string, advance the $current_index to the end of the string
+     * After a single or double quote string, advance the $current_index to the
+     * end of the string
      *
      * @param State $state The parser state.
      *
      */
-    protected function handleQuotedString($state)
+    protected function handleQuotedString(State $state)
     {
         $quoteCharacter = $state->getCurrentCharacter();
         $state->copyCurrentCharacter();
@@ -143,12 +160,13 @@ protected function handleQuotedString($state)
 
     /**
      *
-     * Check if a ':' colon character is followed by what can be a named placeholder.
+     * Check if a ':' colon character is followed by what can be a named
+     * placeholder.
      *
      * @param State $state The parser state.
      *
      */
-    protected function handleColon($state)
+    protected function handleColon(State $state)
     {
         $colon_number = 0;
         do {
@@ -186,13 +204,16 @@ protected function handleColon($state)
 
     /**
      *
-     * Replace a numbered placeholder character by multiple ones if a numbered placeholder contains an array.
-     * As the '?' character can't be used with PG queries, replace it with a named placeholder
+     * Replace a numbered placeholder character by multiple ones if a numbered
+     * placeholder contains an array.
+     *
+     * As the '?' character can't be used with PG queries, replace it with a
+     * named placeholder.
      *
      * @param State $state The parser state.
      *
      */
-    protected function handleNumberedParameter($state)
+    protected function handleNumberedParameter(State $state)
     {
         $value = $state->getFirstUnusedNumberedValue();
 
@@ -221,7 +242,7 @@ protected function handleNumberedParameter($state)
      * @param State $state The parser state.
      *
      */
-    protected function handleSemiColon($state)
+    protected function handleSemiColon(State $state)
     {
         $uselessCharacters = $state->capture(';\\s*');
         $state->passString($uselessCharacters);
@@ -236,7 +257,7 @@ protected function handleSemiColon($state)
      * @param State $state The parser state.
      *
      */
-    protected function handleSingleLineComment($state)
+    protected function handleSingleLineComment(State $state)
     {
         if ($state->nextCharactersAre('-')) {
             $state->copyUntilCharacter("\n");
@@ -253,7 +274,7 @@ protected function handleSingleLineComment($state)
      * @param State $state The parser state.
      *
      */
-    protected function handleMultiLineComment($state)
+    protected function handleMultiLineComment(State $state)
     {
         if ($state->nextCharactersAre('*')) {
             $state->copyUntilCharacter('*/');

diff --git a/src/Parser/MysqlParser.php b/src/Parser/MysqlParser.php
@@ -17,6 +17,13 @@
  */
 class MysqlParser extends AbstractParser
 {
+    /**
+     *
+     * Map of characters to handler methods.
+     *
+     * @var array
+     *
+     */
     protected $handlers = [
         '-' => 'handleSingleLineComment',
         '/' => 'handleMultiLineComment',
@@ -37,7 +44,7 @@ class MysqlParser extends AbstractParser
      * @param State $state The parser state.
      *
      */
-    protected function handleSingleLineComment($state)
+    protected function handleSingleLineComment(State $state)
     {
         $isComment = $state->nextCharactersAre("- ")
             || $state->nextCharactersAre("-\t")
@@ -58,7 +65,7 @@ protected function handleSingleLineComment($state)
      * @param State $state The parser state.
      *
      */
-    protected function handleMySQLQuotedString($state)
+    protected function handleMySQLQuotedString(State $state)
     {
         $quoteCharacter = $state->getCurrentCharacter();
         $state->copyCurrentCharacter();

diff --git a/src/Parser/ParserInterface.php b/src/Parser/ParserInterface.php
@@ -8,6 +8,13 @@
  */
 namespace Aura\Sql\Parser;
 
+/**
+ *
+ * Interface for query parsing/rebuilding functionality.
+ *
+ * @package aura/sql
+ *
+ */
 interface ParserInterface
 {
     /**

diff --git a/src/Parser/PgsqlParser.php b/src/Parser/PgsqlParser.php
@@ -17,6 +17,13 @@
  */
 class PgsqlParser extends AbstractParser
 {
+    /**
+     *
+     * Map of characters to handler methods.
+     *
+     * @var array
+     *
+     */
     protected $handlers = [
         '-' => 'handleSingleLineComment',
         '/' => 'handleMultiLineComment',
@@ -38,7 +45,7 @@ class PgsqlParser extends AbstractParser
      * @param State $state The parser state.
      *
      */
-    protected function handleMultiLineComment($state)
+    protected function handleMultiLineComment(State $state)
     {
         if ($state->nextCharactersAre('*')) {
             // PG handled multiple levels of comments
@@ -64,7 +71,7 @@ protected function handleMultiLineComment($state)
      * @param State $state The parser state.
      *
      */
-    protected function handlePossibleCStyleString($state)
+    protected function handlePossibleCStyleString(State $state)
     {
         $state->copyCurrentCharacter();
         if (! $state->done() && ($currentCharacter = $state->getCurrentCharacter()) === "'") {
@@ -102,7 +109,7 @@ protected function handlePossibleCStyleString($state)
      * @param State $state The parser state.
      *
      */
-    protected function handleDollar($state)
+    protected function handleDollar(State $state)
     {
         $identifier = $state->capture('\\$([a-zA-Z_]\\w*)*\\$');
         if ($identifier) {
@@ -120,7 +127,7 @@ protected function handleDollar($state)
      * @param State $state The parser state.
      *
      */
-    protected function handleArray($state)
+    protected function handleArray(State $state)
     {
         $state->copyUntilCharacter(']');
     }

diff --git a/src/Parser/SqliteParser.php b/src/Parser/SqliteParser.php
@@ -17,6 +17,13 @@
  */
 class SqliteParser extends AbstractParser
 {
+    /**
+     *
+     * Map of characters to handler methods.
+     *
+     * @var array
+     *
+     */
     protected $handlers = [
         '-' => 'handleSingleLineComment',
         '/' => 'handleMultiLineComment',
@@ -34,7 +41,7 @@ class SqliteParser extends AbstractParser
      * @param State $state The parser state.
      *
      */
-    protected function handleSqliteQuotedString($state)
+    protected function handleSqliteQuotedString(State $state)
     {
         $quoteCharacter = $state->getCurrentCharacter();
         $state->copyCurrentCharacter();

diff --git a/src/Parser/SqlsrvParser.php b/src/Parser/SqlsrvParser.php
@@ -17,6 +17,13 @@
  */
 class SqlsrvParser extends AbstractParser
 {
+    /**
+     *
+     * Map of characters to handler methods.
+     *
+     * @var array
+     *
+     */
     protected $handlers = [
         '-' => 'handleSingleLineComment',
         '/' => 'handleMultiLineComment',
@@ -35,7 +42,7 @@ class SqlsrvParser extends AbstractParser
      * @param State $state The parser state.
      *
      */
-    protected function handleIdentifier($state)
+    protected function handleIdentifier(State $state)
     {
         $state->copyUntilCharacter(']');
     }