Skip to content

Commit

Permalink
Mark many of the Database internals as such.
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
markstory committed Jun 16, 2014
1 parent e9aba0f commit 1549549
Show file tree
Hide file tree
Showing 23 changed files with 41 additions and 4 deletions.
2 changes: 1 addition & 1 deletion src/Database/Connection.php
Expand Up @@ -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.
Expand Down
2 changes: 2 additions & 0 deletions src/Database/Dialect/MysqlDialectTrait.php
Expand Up @@ -19,6 +19,8 @@
/**
* Contains functions that encapsulates the SQL dialect used by MySQL,
* including query translators and schema introspection.
*
* @internal
*/
trait MysqlDialectTrait {

Expand Down
2 changes: 2 additions & 0 deletions src/Database/Dialect/PostgresDialectTrait.php
Expand Up @@ -22,6 +22,8 @@
/**
* Contains functions that encapsulates the SQL dialect used by Postgres,
* including query translators and schema introspection.
*
* @internal
*/
trait PostgresDialectTrait {

Expand Down
4 changes: 3 additions & 1 deletion src/Database/Dialect/SqliteDialectTrait.php
Expand Up @@ -20,7 +20,9 @@
use Cake\Database\SqlDialectTrait;

/**
* Sql dialect trait
* SQLite dialect trait
*
* @internal
*/
trait SqliteDialectTrait {

Expand Down
2 changes: 2 additions & 0 deletions src/Database/Dialect/SqlserverDialectTrait.php
Expand Up @@ -26,6 +26,8 @@
/**
* Contains functions that encapsulates the SQL dialect used by SQLServer,
* including query translators and schema introspection.
*
* @internal
*/
trait SqlserverDialectTrait {

Expand Down
2 changes: 2 additions & 0 deletions src/Database/Dialect/TupleComparisonTranslatorTrait.php
Expand Up @@ -21,6 +21,8 @@

/**
* Provides a translator method for tuple comparisons
*
* @internal
*/
trait TupleComparisonTranslatorTrait {

Expand Down
1 change: 1 addition & 0 deletions src/Database/Expression/Comparison.php
Expand Up @@ -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 {

Expand Down
2 changes: 2 additions & 0 deletions src/Database/Expression/FunctionExpression.php
Expand Up @@ -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 {

Expand Down
1 change: 1 addition & 0 deletions src/Database/Expression/IdentifierExpression.php
Expand Up @@ -20,6 +20,7 @@
/**
* Represents a single identifier name in the database
*
* @internal
*/
class IdentifierExpression implements ExpressionInterface {

Expand Down
5 changes: 5 additions & 0 deletions src/Database/Expression/OrderByExpression.php
Expand Up @@ -17,6 +17,11 @@
use Cake\Database\ExpressionInterface;
use Cake\Database\ValueBinder;

/**
* An expression object for ORDER BY clauses
*
* @internal
*/
class OrderByExpression extends QueryExpression {

/**
Expand Down
3 changes: 2 additions & 1 deletion src/Database/Expression/QueryExpression.php
Expand Up @@ -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 {

Expand Down Expand Up @@ -511,4 +512,4 @@ protected function _bindMultiplePlaceholders($field, $values, $type) {
return implode(', ', $params);
}

}
}
2 changes: 2 additions & 0 deletions src/Database/Expression/TupleComparison.php
Expand Up @@ -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 {

Expand Down
2 changes: 2 additions & 0 deletions src/Database/Expression/UnaryExpression.php
Expand Up @@ -19,6 +19,8 @@

/**
* An expression object that represents an expression with only a single operand.
*
* @internal
*/
class UnaryExpression extends QueryExpression {

Expand Down
2 changes: 2 additions & 0 deletions src/Database/Expression/ValuesExpression.php
Expand Up @@ -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 {

Expand Down
2 changes: 2 additions & 0 deletions src/Database/IdentifierQuoter.php
Expand Up @@ -21,6 +21,8 @@

/**
* Contains all the logic related to quoting identifiers in a Query object
*
* @internal
*/
class IdentifierQuoter {

Expand Down
2 changes: 2 additions & 0 deletions src/Database/Log/LoggedQuery.php
Expand Up @@ -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 {

Expand Down
2 changes: 1 addition & 1 deletion src/Database/Log/LoggingStatement.php
Expand Up @@ -19,7 +19,7 @@
/**
* Statement decorator used to
*
* @return void
* @internal
*/
class LoggingStatement extends StatementDecorator {

Expand Down
1 change: 1 addition & 0 deletions src/Database/Log/QueryLogger.php
Expand Up @@ -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 {

Expand Down
1 change: 1 addition & 0 deletions src/Database/QueryCompiler.php
Expand Up @@ -20,6 +20,7 @@
/**
* Responsible for compiling a Query object into its SQL representation
*
* @internal
*/
class QueryCompiler {

Expand Down
1 change: 1 addition & 0 deletions src/Database/SqlserverCompiler.php
Expand Up @@ -20,6 +20,7 @@
* Responsible for compiling a Query object into its SQL representation
* for SQL Server
*
* @internal
*/
class SqlserverCompiler extends QueryCompiler {

Expand Down
1 change: 1 addition & 0 deletions src/Database/Statement/SqliteStatement.php
Expand Up @@ -17,6 +17,7 @@
/**
* Statement class meant to be used by an Sqlite driver
*
* @internal
*/
class SqliteStatement extends BufferedStatement {

Expand Down
1 change: 1 addition & 0 deletions src/Database/Statement/SqlserverStatement.php
Expand Up @@ -20,6 +20,7 @@
/**
* Statement class meant to be used by an Sqlserver driver
*
* @internal
*/
class SqlserverStatement extends PDOStatement {

Expand Down
2 changes: 2 additions & 0 deletions src/Database/ValueBinder.php
Expand Up @@ -16,6 +16,8 @@

/**
* Value binder class manages list of values bound to conditions.
*
* @internal
*/
class ValueBinder {

Expand Down

0 comments on commit 1549549

Please sign in to comment.