From 1549549955c19631d527ffeb7dc3318ebc3824aa Mon Sep 17 00:00:00 2001
From: mark_story <mark@mark-story.com>
Date: Sun, 15 Jun 2014 22:45:56 -0400
Subject: [PATCH] Mark many of the Database internals as such.

Marking these classes as internal as they are subject to change for the
first few versions of 3.0. Until we get all the potential issues sorted
I don't want to make any backwards compatibility promises on these
classes.
---
 src/Database/Connection.php                             | 2 +-
 src/Database/Dialect/MysqlDialectTrait.php              | 2 ++
 src/Database/Dialect/PostgresDialectTrait.php           | 2 ++
 src/Database/Dialect/SqliteDialectTrait.php             | 4 +++-
 src/Database/Dialect/SqlserverDialectTrait.php          | 2 ++
 src/Database/Dialect/TupleComparisonTranslatorTrait.php | 2 ++
 src/Database/Expression/Comparison.php                  | 1 +
 src/Database/Expression/FunctionExpression.php          | 2 ++
 src/Database/Expression/IdentifierExpression.php        | 1 +
 src/Database/Expression/OrderByExpression.php           | 5 +++++
 src/Database/Expression/QueryExpression.php             | 3 ++-
 src/Database/Expression/TupleComparison.php             | 2 ++
 src/Database/Expression/UnaryExpression.php             | 2 ++
 src/Database/Expression/ValuesExpression.php            | 2 ++
 src/Database/IdentifierQuoter.php                       | 2 ++
 src/Database/Log/LoggedQuery.php                        | 2 ++
 src/Database/Log/LoggingStatement.php                   | 2 +-
 src/Database/Log/QueryLogger.php                        | 1 +
 src/Database/QueryCompiler.php                          | 1 +
 src/Database/SqlserverCompiler.php                      | 1 +
 src/Database/Statement/SqliteStatement.php              | 1 +
 src/Database/Statement/SqlserverStatement.php           | 1 +
 src/Database/ValueBinder.php                            | 2 ++
 23 files changed, 41 insertions(+), 4 deletions(-)

diff --git a/src/Database/Connection.php b/src/Database/Connection.php
index 999fb327146..2572e229bd6 100644
--- a/src/Database/Connection.php
+++ b/src/Database/Connection.php
@@ -134,7 +134,7 @@ public function configName() {
  *
  * If no params are passed it will return the current driver instance.
  *
- * @param string|Driver $driver The driver instance to use.
+ * @param string|\Cake\Database\Driver $driver The driver instance to use.
  * @param array|null $config Either config for a new driver or null.
  * @throws \Cake\Database\Error\MissingDriverException When a driver class is missing.
  * @throws \Cake\Database\Error\MissingExtensionException When a driver's PHP extension is missing.
diff --git a/src/Database/Dialect/MysqlDialectTrait.php b/src/Database/Dialect/MysqlDialectTrait.php
index 7240c067770..f86294a8165 100644
--- a/src/Database/Dialect/MysqlDialectTrait.php
+++ b/src/Database/Dialect/MysqlDialectTrait.php
@@ -19,6 +19,8 @@
 /**
  * Contains functions that encapsulates the SQL dialect used by MySQL,
  * including query translators and schema introspection.
+ *
+ * @internal
  */
 trait MysqlDialectTrait {
 
diff --git a/src/Database/Dialect/PostgresDialectTrait.php b/src/Database/Dialect/PostgresDialectTrait.php
index 64f3c919cb3..8ad4e7488f1 100644
--- a/src/Database/Dialect/PostgresDialectTrait.php
+++ b/src/Database/Dialect/PostgresDialectTrait.php
@@ -22,6 +22,8 @@
 /**
  * Contains functions that encapsulates the SQL dialect used by Postgres,
  * including query translators and schema introspection.
+ *
+ * @internal
  */
 trait PostgresDialectTrait {
 
diff --git a/src/Database/Dialect/SqliteDialectTrait.php b/src/Database/Dialect/SqliteDialectTrait.php
index 2e6241bedb3..493da68eb67 100644
--- a/src/Database/Dialect/SqliteDialectTrait.php
+++ b/src/Database/Dialect/SqliteDialectTrait.php
@@ -20,7 +20,9 @@
 use Cake\Database\SqlDialectTrait;
 
 /**
- * Sql dialect trait
+ * SQLite dialect trait
+ *
+ * @internal
  */
 trait SqliteDialectTrait {
 
diff --git a/src/Database/Dialect/SqlserverDialectTrait.php b/src/Database/Dialect/SqlserverDialectTrait.php
index 71e7be2caf9..5aea0d571b3 100644
--- a/src/Database/Dialect/SqlserverDialectTrait.php
+++ b/src/Database/Dialect/SqlserverDialectTrait.php
@@ -26,6 +26,8 @@
 /**
  * Contains functions that encapsulates the SQL dialect used by SQLServer,
  * including query translators and schema introspection.
+ *
+ * @internal
  */
 trait SqlserverDialectTrait {
 
diff --git a/src/Database/Dialect/TupleComparisonTranslatorTrait.php b/src/Database/Dialect/TupleComparisonTranslatorTrait.php
index 62103885dba..61d7b89419e 100644
--- a/src/Database/Dialect/TupleComparisonTranslatorTrait.php
+++ b/src/Database/Dialect/TupleComparisonTranslatorTrait.php
@@ -21,6 +21,8 @@
 
 /**
  * Provides a translator method for tuple comparisons
+ *
+ * @internal
  */
 trait TupleComparisonTranslatorTrait {
 
diff --git a/src/Database/Expression/Comparison.php b/src/Database/Expression/Comparison.php
index 89e1cca0647..5d3ddd50cc0 100644
--- a/src/Database/Expression/Comparison.php
+++ b/src/Database/Expression/Comparison.php
@@ -22,6 +22,7 @@
  * involving a field an operator and a value. In its most common form the
  * string representation of a comparison is `field = value`
  *
+ * @internal
  */
 class Comparison extends QueryExpression {
 
diff --git a/src/Database/Expression/FunctionExpression.php b/src/Database/Expression/FunctionExpression.php
index d2d1699c554..201716ae417 100644
--- a/src/Database/Expression/FunctionExpression.php
+++ b/src/Database/Expression/FunctionExpression.php
@@ -22,6 +22,8 @@
  * constructed by passing the name of the function and a list of params.
  * For security reasons, all params passed are quoted by default unless
  * explicitly told otherwise.
+ *
+ * @internal
  */
 class FunctionExpression extends QueryExpression {
 
diff --git a/src/Database/Expression/IdentifierExpression.php b/src/Database/Expression/IdentifierExpression.php
index b9c19cbb8a7..0c590f8b064 100644
--- a/src/Database/Expression/IdentifierExpression.php
+++ b/src/Database/Expression/IdentifierExpression.php
@@ -20,6 +20,7 @@
 /**
  * Represents a single identifier name in the database
  *
+ * @internal
  */
 class IdentifierExpression implements ExpressionInterface {
 
diff --git a/src/Database/Expression/OrderByExpression.php b/src/Database/Expression/OrderByExpression.php
index d2ae7d5336d..670ad44b714 100644
--- a/src/Database/Expression/OrderByExpression.php
+++ b/src/Database/Expression/OrderByExpression.php
@@ -17,6 +17,11 @@
 use Cake\Database\ExpressionInterface;
 use Cake\Database\ValueBinder;
 
+/**
+ * An expression object for ORDER BY clauses
+ *
+ * @internal
+ */
 class OrderByExpression extends QueryExpression {
 
 /**
diff --git a/src/Database/Expression/QueryExpression.php b/src/Database/Expression/QueryExpression.php
index b53b7445e16..134cd56f20c 100644
--- a/src/Database/Expression/QueryExpression.php
+++ b/src/Database/Expression/QueryExpression.php
@@ -26,6 +26,7 @@
  * expressions that can be compiled by converting this object to string
  * and will contain a correctly parenthesized and nested expression.
  *
+ * @internal
  */
 class QueryExpression implements ExpressionInterface, Countable {
 
@@ -511,4 +512,4 @@ protected function _bindMultiplePlaceholders($field, $values, $type) {
 		return implode(', ', $params);
 	}
 
-}
\ No newline at end of file
+}
diff --git a/src/Database/Expression/TupleComparison.php b/src/Database/Expression/TupleComparison.php
index 71df7f7f5cc..6637979f426 100644
--- a/src/Database/Expression/TupleComparison.php
+++ b/src/Database/Expression/TupleComparison.php
@@ -21,6 +21,8 @@
 /**
  * This expression represents SQL fragments that are used for comparing one tuple
  * to another, one tuple to a set of other tuples or one tuple to an expression
+ *
+ * @internal
  */
 class TupleComparison extends Comparison {
 
diff --git a/src/Database/Expression/UnaryExpression.php b/src/Database/Expression/UnaryExpression.php
index ad654144f29..89264ad25c1 100644
--- a/src/Database/Expression/UnaryExpression.php
+++ b/src/Database/Expression/UnaryExpression.php
@@ -19,6 +19,8 @@
 
 /**
  * An expression object that represents an expression with only a single operand.
+ *
+ * @internal
  */
 class UnaryExpression extends QueryExpression {
 
diff --git a/src/Database/Expression/ValuesExpression.php b/src/Database/Expression/ValuesExpression.php
index f773e616685..02470d4bd72 100644
--- a/src/Database/Expression/ValuesExpression.php
+++ b/src/Database/Expression/ValuesExpression.php
@@ -26,6 +26,8 @@
  *
  * Helps generate SQL with the correct number of placeholders and bind
  * values correctly into the statement.
+ *
+ * @internal
  */
 class ValuesExpression implements ExpressionInterface {
 
diff --git a/src/Database/IdentifierQuoter.php b/src/Database/IdentifierQuoter.php
index a8a5cdab2a2..1c11099188b 100644
--- a/src/Database/IdentifierQuoter.php
+++ b/src/Database/IdentifierQuoter.php
@@ -21,6 +21,8 @@
 
 /**
  * Contains all the logic related to quoting identifiers in a Query object
+ *
+ * @internal
  */
 class IdentifierQuoter {
 
diff --git a/src/Database/Log/LoggedQuery.php b/src/Database/Log/LoggedQuery.php
index 7528c84a9c5..aaf37842815 100644
--- a/src/Database/Log/LoggedQuery.php
+++ b/src/Database/Log/LoggedQuery.php
@@ -17,6 +17,8 @@
 /**
  * Contains a query string, the params used to executed it, time taken to do it
  * and the number of rows found or affected by its execution.
+ *
+ * @internal
  */
 class LoggedQuery {
 
diff --git a/src/Database/Log/LoggingStatement.php b/src/Database/Log/LoggingStatement.php
index 87e111442b1..9804aa8c201 100644
--- a/src/Database/Log/LoggingStatement.php
+++ b/src/Database/Log/LoggingStatement.php
@@ -19,7 +19,7 @@
 /**
  * Statement decorator used to
  *
- * @return void
+ * @internal
  */
 class LoggingStatement extends StatementDecorator {
 
diff --git a/src/Database/Log/QueryLogger.php b/src/Database/Log/QueryLogger.php
index 939fd3010dc..800c3255dea 100644
--- a/src/Database/Log/QueryLogger.php
+++ b/src/Database/Log/QueryLogger.php
@@ -22,6 +22,7 @@
  * This class is a bridge used to write LoggedQuery objects into a real log.
  * by default this class use the built-in CakePHP Log class to accomplish this
  *
+ * @internal
  */
 class QueryLogger {
 
diff --git a/src/Database/QueryCompiler.php b/src/Database/QueryCompiler.php
index bf140112b33..886d86f47b9 100644
--- a/src/Database/QueryCompiler.php
+++ b/src/Database/QueryCompiler.php
@@ -20,6 +20,7 @@
 /**
  * Responsible for compiling a Query object into its SQL representation
  *
+ * @internal
  */
 class QueryCompiler {
 
diff --git a/src/Database/SqlserverCompiler.php b/src/Database/SqlserverCompiler.php
index 6c9f7bb830e..f76315a3c22 100644
--- a/src/Database/SqlserverCompiler.php
+++ b/src/Database/SqlserverCompiler.php
@@ -20,6 +20,7 @@
  * Responsible for compiling a Query object into its SQL representation
  * for SQL Server
  *
+ * @internal
  */
 class SqlserverCompiler extends QueryCompiler {
 
diff --git a/src/Database/Statement/SqliteStatement.php b/src/Database/Statement/SqliteStatement.php
index 298d39cba9f..e4844428062 100644
--- a/src/Database/Statement/SqliteStatement.php
+++ b/src/Database/Statement/SqliteStatement.php
@@ -17,6 +17,7 @@
 /**
  * Statement class meant to be used by an Sqlite driver
  *
+ * @internal
  */
 class SqliteStatement extends BufferedStatement {
 
diff --git a/src/Database/Statement/SqlserverStatement.php b/src/Database/Statement/SqlserverStatement.php
index 9911f927fd4..572ec73d02c 100644
--- a/src/Database/Statement/SqlserverStatement.php
+++ b/src/Database/Statement/SqlserverStatement.php
@@ -20,6 +20,7 @@
 /**
  * Statement class meant to be used by an Sqlserver driver
  *
+ * @internal
  */
 class SqlserverStatement extends PDOStatement {
 
diff --git a/src/Database/ValueBinder.php b/src/Database/ValueBinder.php
index 141f216e813..1e7c2e154b7 100644
--- a/src/Database/ValueBinder.php
+++ b/src/Database/ValueBinder.php
@@ -16,6 +16,8 @@
 
 /**
  * Value binder class manages list of values bound to conditions.
+ *
+ * @internal
  */
 class ValueBinder {