Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Fix doc blocks

  • Loading branch information...
commit 5f3781c7922d065717b8487f43389f7ecd6a9878 1 parent 3a440ce
@rockingeric rockingeric authored
View
2  src/Database/Dialect/SqliteDialectTrait.php
@@ -149,7 +149,7 @@ protected function _transformTupleComparison(TupleComparison $expression, $query
*
* The way SQLite works with multi insert is by having multiple select statements
* joined with UNION.
- *
+ * @param Cake\Database\Query $query The query to translate
* @return Query
*/
protected function _insertQueryTranslator($query) {
View
5 src/Database/Driver.php
@@ -78,6 +78,7 @@ public function __construct($config = []) {
* Returns correct connection resource or object that is internally used
* If first argument is passed,
*
+ * @param null|PDO instance $connection
* @return void
*/
public abstract function connection($connection = null);
@@ -130,6 +131,8 @@ public function supportsSavePoints() {
/**
* Returns a value in a safe representation to be used in a query string
*
+ * @param mixed $value
+ * @param string $type Type to be used for determining kind of quoting to perform
* @return string
*/
public abstract function quote($value, $type);
@@ -208,7 +211,7 @@ public function schemaValue($value) {
* Returns last id generated for a table or sequence in database
*
* @param string $table table name or sequence to get last insert value from
- * @param string column the name of the column representing the primary key
+ * @param string $column the name of the column representing the primary key
* @return string|integer
*/
public function lastInsertId($table = null, $column = null) {
View
6 src/Database/Driver/PDODriverTrait.php
@@ -50,7 +50,7 @@ protected function _connect(array $config) {
* Returns correct connection resource or object that is internally used
* If first argument is passed, it will set internal conenction object or
* result to the value passed
- *
+ * @param null|PDO instance $connection
* @return mixed connection object used internally
*/
public function connection($connection = null) {
@@ -122,7 +122,8 @@ public function rollbackTransaction() {
/**
* Returns a value in a safe representation to be used in a query string
- *
+ * @param mixed $value
+ * @param string $type Type to be used for determining kind of quoting to perform
* @return string
*/
public function quote($value, $type) {
@@ -134,6 +135,7 @@ public function quote($value, $type) {
* Returns last id generated for a table or sequence in database
*
* @param string $table table name or sequence to get last insert value from
+ * @param string $column the name of the column representing the primary key
* @return string|integer
*/
public function lastInsertId($table = null, $column = null) {
View
2  src/Database/Driver/Postgres.php
@@ -96,6 +96,7 @@ public function enabled() {
/**
* Sets connection encoding
*
+ * @param string $encoding
* @return void
*/
public function setEncoding($encoding) {
@@ -107,6 +108,7 @@ public function setEncoding($encoding) {
* Sets connection default schema, if any relation defined in a query is not fully qualified
* postgres will fallback to looking the relation into defined default schema
*
+ * @param string $schema
* @return void
*/
public function setSchema($schema) {
View
2  src/Database/Expression/QueryExpression.php
@@ -456,7 +456,7 @@ protected function _addConditions(array $conditions, array $types) {
* @param string $field The value from with the actual field and operator will
* be extracted.
* @param mixed $value The value to be bound to a placeholder for the field
- * $param array $types List of types where the field can be found so the value
+ * @param array $types List of types where the field can be found so the value
* can be converted accordingly.
* @return string|QueryExpression
*/
View
2  src/Database/Expression/TupleComparison.php
@@ -160,7 +160,7 @@ public function traverse(callable $callable) {
* it is an ExpressionInterface
*
* @param mixed $value
- * @Param callable $callable
+ * @param callable $callable
* @return void
*/
protected function _traverseValue($value, $callable) {
View
6 src/Database/Log/LoggingStatement.php
@@ -19,7 +19,7 @@
use Cake\Database\Statement\StatementDecorator;
/**
- * Statement decorator used to
+ * Statement decorator used to
*
* @return void
*/
@@ -43,7 +43,7 @@ class LoggingStatement extends StatementDecorator {
* Wrapper for the execute function to calculate time spent
* and log the query afterwards.
*
- * $param array $params list of values to be bound to query
+ * @param array $params list of values to be bound to query
* @return boolean true on success, false otherwise
*/
public function execute($params = null) {
@@ -67,7 +67,7 @@ public function execute($params = null) {
* @param string|integer $column name or param position to be bound
* @param mixed $value the value to bind to variable in query
* @param string|integer $type PDO type or name of configured Type class
- * @return void
+ * @return void
*/
public function bindValue($column, $value, $type = 'string') {
parent::bindValue($column, $value, $type);
View
1  src/Database/Log/QueryLogger.php
@@ -55,6 +55,7 @@ protected function _log($query) {
* Helper function used to replace query placeholders by the real
* params used to execute the query
*
+ * @param LoggedQuery $query
* @return string
*/
protected function _interpolate($query) {
View
4 src/Database/Statement/BufferedStatement.php
@@ -29,6 +29,7 @@ class BufferedStatement extends StatementDecorator {
/**
* Constructor
*
+ * @param Cake\Database\Driver instance $driver
* @param Statement implementation such as PDOStatement
* @return void
*/
@@ -37,6 +38,9 @@ public function __construct($statement = null, $driver = null) {
$this->_reset();
}
+ /**
+ * @param array $params list of values to be bound to query
+ */
public function execute($params = null) {
$this->_reset();
return parent::execute($params);
View
1  src/Database/Statement/PDOStatement.php
@@ -29,6 +29,7 @@ class PDOStatement extends StatementDecorator {
* Constructor
*
* @param \PDOStatement original statement to be decorated
+ * @param Cake\Database\Driver instance $driver
* @return void
*/
public function __construct(Statement $statement = null, $driver = null) {
View
3  src/Database/Statement/StatementDecorator.php
@@ -51,6 +51,7 @@ class StatementDecorator implements StatementInterface, \Countable, \IteratorAgg
* Constructor
*
* @param Statement implementation such as PDOStatement
+ * @param Cake\Database\Driver instance $driver
* @return void
*/
public function __construct($statement = null, $driver = null) {
@@ -147,7 +148,7 @@ public function errorInfo() {
* that binding parameters from this method will not perform any custom type conversion
* as it would normally happen when calling `bindValue`
*
- * $param array $params list of values to be bound to query
+ * @param array $params list of values to be bound to query
* @return boolean true on success, false otherwise
*/
public function execute($params = null) {
Please sign in to comment.
Something went wrong with that request. Please try again.