Add constant types via PHPDocs

Author: natanfelles

src/Manipulation/Delete.php

@@ -25,8 +25,17 @@ class Delete extends Statement
  use Traits\OrderBy;
  use Traits\Where;
 
+ /**
+ * @var string
+ */
  public const OPT_LOW_PRIORITY = 'LOW_PRIORITY';
+ /**
+ * @var string
+ */
  public const OPT_QUICK = 'QUICK';
+ /**
+ * @var string
+ */
  public const OPT_IGNORE = 'IGNORE';
 
  protected function renderOptions() : ?string

src/Manipulation/Insert.php

@@ -26,20 +26,28 @@ class Insert extends Statement
 
  /**
  * @see https://mariadb.com/kb/en/library/insert-delayed/
+ *
+ * @var string
  */
  public const OPT_DELAYED = 'DELAYED';
  /**
  * Convert errors to warnings, which will not stop inserts of additional rows.
  *
  * @see https://mariadb.com/kb/en/library/insert-ignore/
+ *
+ * @var string
  */
  public const OPT_IGNORE = 'IGNORE';
  /**
  * @see https://mariadb.com/kb/en/library/high_priority-and-low_priority/
+ *
+ * @var string
  */
  public const OPT_HIGH_PRIORITY = 'HIGH_PRIORITY';
  /**
  * @see https://mariadb.com/kb/en/library/high_priority-and-low_priority/
+ *
+ * @var string
  */
  public const OPT_LOW_PRIORITY = 'LOW_PRIORITY';
 

src/Manipulation/LoadData.php

@@ -25,14 +25,20 @@ class LoadData extends Statement
 
  /**
  * @see https://mariadb.com/kb/en/library/high_priority-and-low_priority/
+ *
+ * @var string
  */
  public const OPT_LOW_PRIORITY = 'LOW_PRIORITY';
  /**
  * @see https://mariadb.com/kb/en/load-data-infile/#priority-and-concurrency
+ *
+ * @var string
  */
  public const OPT_CONCURRENT = 'CONCURRENT';
  /**
  * @see https://mariadb.com/kb/en/load-data-infile/#load-data-local-infile
+ *
+ * @var string
  */
  public const OPT_LOCAL = 'LOCAL';
 

src/Manipulation/Replace.php

@@ -26,10 +26,14 @@ class Replace extends Statement
 
  /**
  * @see https://mariadb.com/kb/en/library/insert-delayed/
+ *
+ * @var string
  */
  public const OPT_DELAYED = 'DELAYED';
  /**
  * @see https://mariadb.com/kb/en/library/high_priority-and-low_priority/
+ *
+ * @var string
  */
  public const OPT_LOW_PRIORITY = 'LOW_PRIORITY';
 

src/Manipulation/Select.php

@@ -31,19 +31,25 @@ class Select extends Statement
  * Option to retrieve identical rows.
  *
  * @see Select::renderOptions()
+ *
+ * @var string
  */
  public const OPT_ALL = 'ALL';
  /**
  * Option to not retrieve identical rows. Remove duplicates from the resultset.
  *
  * @see Select::renderOptions()
  * @see https://mariadb.com/kb/en/library/select/#distinct
+ *
+ * @var string
  */
  public const OPT_DISTINCT = 'DISTINCT';
  /**
  * Alias of OPT_DISTINCT.
  *
  * @see Select::renderOptions()
+ *
+ * @var string
  */
  public const OPT_DISTINCTROW = 'DISTINCTROW';
  /**
@@ -53,6 +59,8 @@ class Select extends Statement
  *
  * @see Select::renderOptions()
  * @see https://mariadb.com/kb/en/library/high_priority-and-low_priority/
+ *
+ * @var string
  */
  public const OPT_HIGH_PRIORITY = 'HIGH_PRIORITY';
  /**
@@ -63,19 +71,25 @@ class Select extends Statement
  * @see Select::renderOptions()
  * @see https://mariadb.com/kb/en/library/join-syntax/
  * @see https://mariadb.com/kb/en/library/index-hints-how-to-force-query-plans/#forcing-join-order
+ *
+ * @var string
  */
  public const OPT_STRAIGHT_JOIN = 'STRAIGHT_JOIN';
  /**
  * Forces the optimizer to use a temporary table.
  *
  * @see https://mariadb.com/kb/en/library/optimizer-hints/#sql_small_result-sql_big_result
+ *
+ * @var string
  */
  public const OPT_SQL_SMALL_RESULT = 'SQL_SMALL_RESULT';
  /**
  * Forces the optimizer to avoid usage of a temporary table.
  *
  * @see Select::renderOptions()
  * @see https://mariadb.com/kb/en/library/optimizer-hints/#sql_small_result-sql_big_result
+ *
+ * @var string
  */
  public const OPT_SQL_BIG_RESULT = 'SQL_BIG_RESULT';
  /**
@@ -84,6 +98,8 @@ class Select extends Statement
  *
  * @see Select::renderOptions()
  * @see https://mariadb.com/kb/en/library/optimizer-hints/#sql_buffer_result
+ *
+ * @var string
  */
  public const OPT_SQL_BUFFER_RESULT = 'SQL_BUFFER_RESULT';
  /**
@@ -93,6 +109,8 @@ class Select extends Statement
  * @see Select::renderOptions()
  * @see https://mariadb.com/kb/en/library/server-system-variables/#query_cache_type
  * @see https://mariadb.com/kb/en/library/query-cache/
+ *
+ * @var string
  */
  public const OPT_SQL_CACHE = 'SQL_CACHE';
  /**
@@ -102,6 +120,8 @@ class Select extends Statement
  * @see Select::renderOptions()
  * @see https://mariadb.com/kb/en/library/server-system-variables/#query_cache_type
  * @see https://mariadb.com/kb/en/library/query-cache/
+ *
+ * @var string
  */
  public const OPT_SQL_NO_CACHE = 'SQL_NO_CACHE';
  /**
@@ -111,36 +131,50 @@ class Select extends Statement
  *
  * @see Select::renderOptions()
  * @see https://mariadb.com/kb/en/library/found_rows/
+ *
+ * @var string
  */
  public const OPT_SQL_CALC_FOUND_ROWS = 'SQL_CALC_FOUND_ROWS';
  /**
  * Clause to set the character of separation between fields. Default is \t.
  *
  * @see Select::intoOutfile()
+ *
+ * @var string
  */
  public const EXP_FIELDS_TERMINATED_BY = 'TERMINATED BY';
  /**
  * Clause to set the enclosure character of the fields. Default is ".
  *
  * @see Select::intoOutfile()
+ *
+ * @var string
  */
  public const EXP_FIELDS_ENCLOSED_BY = 'ENCLOSED BY';
  /**
  * @see Select::intoOutfile()
+ *
+ * @var string
  */
  public const EXP_FIELDS_OPTIONALLY_ENCLOSED_BY = 'OPTIONALLY ENCLOSED BY';
  /**
  * @see Select::intoOutfile()
+ *
+ * @var string
  */
  public const EXP_FIELDS_ESCAPED_BY = 'ESCAPED BY';
  /**
  * @see Select::intoOutfile()
+ *
+ * @var string
  */
  public const EXP_LINES_STARTING_BY = 'STARTING BY';
  /**
  * Clause to set the file End-Of-Line character. Default is \n.
  *
  * @see Select::intoOutfile()
+ *
+ * @var string
  */
  public const EXP_LINES_TERMINATED_BY = 'TERMINATED BY';
 

src/Manipulation/Update.php

@@ -31,10 +31,14 @@ class Update extends Statement
  * Convert errors to warnings, which will not stop inserts of additional rows.
  *
  * @see https://mariadb.com/kb/en/library/insert-ignore/
+ *
+ * @var string
  */
  public const OPT_IGNORE = 'IGNORE';
  /**
  * @see https://mariadb.com/kb/en/library/high_priority-and-low_priority/
+ *
+ * @var string
  */
  public const OPT_LOW_PRIORITY = 'LOW_PRIORITY';
 

src/Manipulation/With.php

@@ -25,6 +25,8 @@ class With extends Statement
 {
  /**
  * @see https://mariadb.com/kb/en/library/recursive-common-table-expressions-overview/
+ *
+ * @var string
  */
  public const OPT_RECURSIVE = 'RECURSIVE';