Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

PHPDoc blocks improvments + 1 CS Fix #125

Merged
merged 4 commits into from about 2 years ago

3 participants

Adrien Brault Jonathan H. Wage Christophe Coevoet
Adrien Brault

Hey guys,

I started to fix a class type inside Connection and then i went ahead to see what i could also improve!

Adrien

lib/Doctrine/DBAL/Connection.php
@@ -419,9 +419,9 @@ public function isTransactionActive()
419 419
     /**
420 420
      * Executes an SQL DELETE statement on a table.
421 421
      *
422  
-     * @param string $table The name of the table on which to delete.
423  
-     * @param array $identifier The deletion criteria. An associateve array containing column-value pairs.
424  
-     * @return integer The number of affected rows.
  422
+     * @param string $tableName The name of the table on which to delete.
  423
+     * @param array $identifier The deletion criteria. An associative array containing column-value pairs.
  424
+     * @return int The number of affected rows.
1
Christophe Coevoet
stof added a note April 02, 2012

you should keep integer which is used everywhere IMO.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
lib/Doctrine/DBAL/Platforms/AbstractPlatform.php
@@ -633,9 +636,9 @@ public function getLowerExpression($str)
633 636
     /**
634 637
      * returns the position of the first occurrence of substring $substr in string $str
635 638
      *
636  
-     * @param string $substr    literal string to find
637  
-     * @param string $str       literal string
638  
-     * @param int    $pos       position to start at, beginning of string by default
  639
+     * @param string  $str       literal string
  640
+     * @param string  $substr    literal string to find
  641
+     * @param boolean $startPos  position to start at, beginning of string by default
1
Christophe Coevoet
stof added a note April 02, 2012

this is wrong. $startPos is either an integer or false when not used

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
lib/Doctrine/DBAL/Platforms/AbstractPlatform.php
@@ -1918,7 +1929,7 @@ public function getAdvancedForeignKeyOptionsSQL(ForeignKeyConstraint $foreignKey
1918 1929
      *
1919 1930
      * @throws Doctrine_Exception_Exception     if unknown referential action given
1
Christophe Coevoet
stof added a note April 02, 2012

the exception name is wrong too

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Adrien Brault

Thanks for the fast feedback. Referenced the PR from my commits, not sure if this is a good idea though.

Jonathan H. Wage
Owner
jwage commented April 03, 2012

:+1:

Jonathan H. Wage jwage merged commit 394f7e9 into from April 03, 2012
Jonathan H. Wage jwage closed this April 03, 2012
David Ward roverwolf referenced this pull request from a commit December 18, 2012
Commit has since been removed from the repository and is no longer available.
David Ward roverwolf referenced this pull request from a commit December 18, 2012
Commit has since been removed from the repository and is no longer available.
David Ward roverwolf referenced this pull request from a commit December 18, 2012
Commit has since been removed from the repository and is no longer available.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
This page is out of date. Refresh to see the latest.
20  lib/Doctrine/DBAL/Cache/ResultCacheStatement.php
@@ -151,23 +151,6 @@ public function getIterator()
151 151
      *                                      This value must be one of the Query::HYDRATE_* constants,
152 152
      *                                      defaulting to Query::HYDRATE_BOTH
153 153
      *
154  
-     * @param integer $cursorOrientation    For a PDOStatement object representing a scrollable cursor,
155  
-     *                                      this value determines which row will be returned to the caller.
156  
-     *                                      This value must be one of the Query::HYDRATE_ORI_* constants, defaulting to
157  
-     *                                      Query::HYDRATE_ORI_NEXT. To request a scrollable cursor for your
158  
-     *                                      PDOStatement object,
159  
-     *                                      you must set the PDO::ATTR_CURSOR attribute to Doctrine::CURSOR_SCROLL when you
160  
-     *                                      prepare the SQL statement with Doctrine_Adapter_Interface->prepare().
161  
-     *
162  
-     * @param integer $cursorOffset         For a PDOStatement object representing a scrollable cursor for which the
163  
-     *                                      $cursorOrientation parameter is set to Query::HYDRATE_ORI_ABS, this value specifies
164  
-     *                                      the absolute number of the row in the result set that shall be fetched.
165  
-     *
166  
-     *                                      For a PDOStatement object representing a scrollable cursor for
167  
-     *                                      which the $cursorOrientation parameter is set to Query::HYDRATE_ORI_REL, this value
168  
-     *                                      specifies the row to fetch relative to the cursor position before
169  
-     *                                      PDOStatement->fetch() was called.
170  
-     *
171 154
      * @return mixed
172 155
      */
173 156
     public function fetch($fetchStyle = PDO::FETCH_BOTH)
@@ -201,9 +184,6 @@ public function fetch($fetchStyle = PDO::FETCH_BOTH)
201 184
      *                                      This value must be one of the Query::HYDRATE_* constants,
202 185
      *                                      defaulting to Query::HYDRATE_BOTH
203 186
      *
204  
-     * @param integer $columnIndex          Returns the indicated 0-indexed column when the value of $fetchStyle is
205  
-     *                                      Query::HYDRATE_COLUMN. Defaults to 0.
206  
-     *
207 187
      * @return array
208 188
      */
209 189
     public function fetchAll($fetchStyle = PDO::FETCH_BOTH)
32  lib/Doctrine/DBAL/Connection.php
@@ -90,22 +90,22 @@ class Connection implements DriverConnection
90 90
     /**
91 91
      * The wrapped driver connection.
92 92
      *
93  
-     * @var Doctrine\DBAL\Driver\Connection
  93
+     * @var \Doctrine\DBAL\Driver\Connection
94 94
      */
95 95
     protected $_conn;
96 96
 
97 97
     /**
98  
-     * @var Doctrine\DBAL\Configuration
  98
+     * @var \Doctrine\DBAL\Configuration
99 99
      */
100 100
     protected $_config;
101 101
 
102 102
     /**
103  
-     * @var Doctrine\Common\EventManager
  103
+     * @var \Doctrine\Common\EventManager
104 104
      */
105 105
     protected $_eventManager;
106 106
 
107 107
     /**
108  
-     * @var Doctrine\DBAL\Query\ExpressionBuilder
  108
+     * @var \Doctrine\DBAL\Query\ExpressionBuilder
109 109
      */
110 110
     protected $_expr;
111 111
 
@@ -148,21 +148,21 @@ class Connection implements DriverConnection
148 148
      * The DatabasePlatform object that provides information about the
149 149
      * database platform used by the connection.
150 150
      *
151  
-     * @var Doctrine\DBAL\Platforms\AbstractPlatform
  151
+     * @var \Doctrine\DBAL\Platforms\AbstractPlatform
152 152
      */
153 153
     protected $_platform;
154 154
 
155 155
     /**
156 156
      * The schema manager.
157 157
      *
158  
-     * @var Doctrine\DBAL\Schema\SchemaManager
  158
+     * @var \Doctrine\DBAL\Schema\AbstractSchemaManager
159 159
      */
160 160
     protected $_schemaManager;
161 161
 
162 162
     /**
163 163
      * The used DBAL driver.
164 164
      *
165  
-     * @var Doctrine\DBAL\Driver
  165
+     * @var \Doctrine\DBAL\Driver
166 166
      */
167 167
     protected $_driver;
168 168
 
@@ -322,7 +322,7 @@ public function getDatabasePlatform()
322 322
     /**
323 323
      * Gets the ExpressionBuilder for the connection.
324 324
      *
325  
-     * @return \Doctrine\DBAL\Query\ExpressionBuilder
  325
+     * @return \Doctrine\DBAL\Query\Expression\ExpressionBuilder
326 326
      */
327 327
     public function getExpressionBuilder()
328 328
     {
@@ -419,8 +419,8 @@ public function isTransactionActive()
419 419
     /**
420 420
      * Executes an SQL DELETE statement on a table.
421 421
      *
422  
-     * @param string $table The name of the table on which to delete.
423  
-     * @param array $identifier The deletion criteria. An associateve array containing column-value pairs.
  422
+     * @param string $tableName The name of the table on which to delete.
  423
+     * @param array $identifier The deletion criteria. An associative array containing column-value pairs.
424 424
      * @return integer The number of affected rows.
425 425
      */
426 426
     public function delete($tableName, array $identifier)
@@ -454,6 +454,7 @@ public function close()
454 454
      * Sets the transaction isolation level.
455 455
      *
456 456
      * @param integer $level The level to set.
  457
+     * @return integer
457 458
      */
458 459
     public function setTransactionIsolation($level)
459 460
     {
@@ -475,7 +476,8 @@ public function getTransactionIsolation()
475 476
     /**
476 477
      * Executes an SQL UPDATE statement on a table.
477 478
      *
478  
-     * @param string $table The name of the table to update.
  479
+     * @param string $tableName The name of the table to update.
  480
+     * @param array $data
479 481
      * @param array $identifier The update criteria. An associative array containing column-value pairs.
480 482
      * @param array $types Types of the merged $data and $identifier arrays in that order.
481 483
      * @return integer The number of affected rows.
@@ -500,7 +502,7 @@ public function update($tableName, array $data, array $identifier, array $types
500 502
     /**
501 503
      * Inserts a table row with specified data.
502 504
      *
503  
-     * @param string $table The name of the table to insert data into.
  505
+     * @param string $tableName The name of the table to insert data into.
504 506
      * @param array $data An associative array containing column-value pairs.
505 507
      * @param array $types Types of the inserted data.
506 508
      * @return integer The number of affected rows.
@@ -863,7 +865,7 @@ public function transactional(Closure $func)
863 865
     /**
864 866
      * Set if nested transactions should use savepoints
865 867
      *
866  
-     * @param boolean
  868
+     * @param boolean $nestTransactionsWithSavepoints
867 869
      * @return void
868 870
      */
869 871
     public function setNestTransactionsWithSavepoints($nestTransactionsWithSavepoints)
@@ -1151,7 +1153,7 @@ public function convertToPHPValue($value, $type)
1151 1153
      * Binds a set of parameters, some or all of which are typed with a PDO binding type
1152 1154
      * or DBAL mapping type, to a given statement.
1153 1155
      *
1154  
-     * @param $stmt The statement to bind the values to.
  1156
+     * @param string $stmt The statement to bind the values to.
1155 1157
      * @param array $params The map/list of named/positional parameters.
1156 1158
      * @param array $types The parameter types (PDO binding types or DBAL mapping types).
1157 1159
      * @internal Duck-typing used on the $stmt parameter to support driver statements as well as
@@ -1213,7 +1215,7 @@ private function getBindingInfo($value, $type)
1213 1215
     /**
1214 1216
      * Create a new instance of a SQL query builder.
1215 1217
      *
1216  
-     * @return Query\QueryBuilder
  1218
+     * @return \Doctrine\DBAL\Query\QueryBuilder
1217 1219
      */
1218 1220
     public function createQueryBuilder()
1219 1221
     {
2  lib/Doctrine/DBAL/Driver.php
@@ -51,7 +51,7 @@ public function getDatabasePlatform();
51 51
      * database schema of the platform this driver connects to.
52 52
      *
53 53
      * @param  \Doctrine\DBAL\Connection $conn
54  
-     * @return \Doctrine\DBAL\SchemaManager
  54
+     * @return \Doctrine\DBAL\Schema\AbstractSchemaManager
55 55
      */
56 56
     public function getSchemaManager(Connection $conn);
57 57
 
20  lib/Doctrine/DBAL/Driver/ResultStatement.php
@@ -62,23 +62,6 @@ public function setFetchMode($fetchStyle);
62 62
      *                                      This value must be one of the Query::HYDRATE_* constants,
63 63
      *                                      defaulting to Query::HYDRATE_BOTH
64 64
      *
65  
-     * @param integer $cursorOrientation    For a PDOStatement object representing a scrollable cursor,
66  
-     *                                      this value determines which row will be returned to the caller.
67  
-     *                                      This value must be one of the Query::HYDRATE_ORI_* constants, defaulting to
68  
-     *                                      Query::HYDRATE_ORI_NEXT. To request a scrollable cursor for your
69  
-     *                                      PDOStatement object,
70  
-     *                                      you must set the PDO::ATTR_CURSOR attribute to Doctrine::CURSOR_SCROLL when you
71  
-     *                                      prepare the SQL statement with Doctrine_Adapter_Interface->prepare().
72  
-     *
73  
-     * @param integer $cursorOffset         For a PDOStatement object representing a scrollable cursor for which the
74  
-     *                                      $cursorOrientation parameter is set to Query::HYDRATE_ORI_ABS, this value specifies
75  
-     *                                      the absolute number of the row in the result set that shall be fetched.
76  
-     *
77  
-     *                                      For a PDOStatement object representing a scrollable cursor for
78  
-     *                                      which the $cursorOrientation parameter is set to Query::HYDRATE_ORI_REL, this value
79  
-     *                                      specifies the row to fetch relative to the cursor position before
80  
-     *                                      PDOStatement->fetch() was called.
81  
-     *
82 65
      * @return mixed
83 66
      */
84 67
     function fetch($fetchStyle = PDO::FETCH_BOTH);
@@ -90,9 +73,6 @@ function fetch($fetchStyle = PDO::FETCH_BOTH);
90 73
      *                                      This value must be one of the Query::HYDRATE_* constants,
91 74
      *                                      defaulting to Query::HYDRATE_BOTH
92 75
      *
93  
-     * @param integer $columnIndex          Returns the indicated 0-indexed column when the value of $fetchStyle is
94  
-     *                                      Query::HYDRATE_COLUMN. Defaults to 0.
95  
-     *
96 76
      * @return array
97 77
      */
98 78
     function fetchAll($fetchStyle = PDO::FETCH_BOTH);
2  lib/Doctrine/DBAL/Driver/Statement.php
@@ -61,7 +61,7 @@ function bindValue($param, $value, $type = null);
61 61
      * of stored procedures that return data as output parameters, and some also as input/output
62 62
      * parameters that both send in data and are updated to receive it.
63 63
      *
64  
-     * @param mixed $param          Parameter identifier. For a prepared statement using named placeholders,
  64
+     * @param mixed $column         Parameter identifier. For a prepared statement using named placeholders,
65 65
      *                              this will be a parameter name of the form :name. For a prepared statement
66 66
      *                              using question mark placeholders, this will be the 1-indexed position of the parameter
67 67
      *
50  lib/Doctrine/DBAL/Platforms/AbstractPlatform.php
@@ -226,6 +226,8 @@ protected function getVarcharTypeDeclarationSQLSnippet($length, $fixed)
226 226
 
227 227
     /**
228 228
      * Gets the SQL Snippet used to declare a BLOB column type.
  229
+     *
  230
+     * @param array $field
229 231
      */
230 232
     abstract public function getBlobTypeDeclarationSQL(array $field);
231 233
 
@@ -269,11 +271,11 @@ public function getDoctrineTypeMapping($dbType)
269 271
         }
270 272
 
271 273
         $dbType = strtolower($dbType);
272  
-        if (isset($this->doctrineTypeMapping[$dbType])) {
273  
-            return $this->doctrineTypeMapping[$dbType];
274  
-        } else {
  274
+        if (!isset($this->doctrineTypeMapping[$dbType])) {
275 275
             throw new \Doctrine\DBAL\DBALException("Unknown database type ".$dbType." requested, " . get_class($this) . " may not support it.");
276 276
         }
  277
+
  278
+        return $this->doctrineTypeMapping[$dbType];
277 279
     }
278 280
 
279 281
     /**
@@ -306,7 +308,7 @@ protected function initializeCommentedDoctrineTypes()
306 308
      * Is it necessary for the platform to add a parsable type comment to allow reverse engineering the given type?
307 309
      *
308 310
      * @param Type $doctrineType
309  
-     * @return bool
  311
+     * @return boolean
310 312
      */
311 313
     public function isCommentedDoctrineType(Type $doctrineType)
312 314
     {
@@ -502,6 +504,7 @@ public function getSumExpression($column)
502 504
      *
503 505
      * Note: Not SQL92, but common functionality
504 506
      *
  507
+     * @param string $column
505 508
      * @return string
506 509
      */
507 510
     public function getMd5Expression($column)
@@ -512,8 +515,7 @@ public function getMd5Expression($column)
512 515
     /**
513 516
      * Returns the length of a text field.
514 517
      *
515  
-     * @param string $expression1
516  
-     * @param string $expression2
  518
+     * @param string $column
517 519
      * @return string
518 520
      */
519 521
     public function getLengthExpression($column)
@@ -535,7 +537,8 @@ public function getSqrtExpression($column)
535 537
     /**
536 538
      * Rounds a numeric field to the number of decimals specified.
537 539
      *
538  
-     * @param string $expression1
  540
+     * @param string $column
  541
+     * @param integer $decimals
539 542
      * @return string
540 543
      */
541 544
     public function getRoundExpression($column, $decimals = 0)
@@ -633,9 +636,9 @@ public function getLowerExpression($str)
633 636
     /**
634 637
      * returns the position of the first occurrence of substring $substr in string $str
635 638
      *
636  
-     * @param string $substr    literal string to find
637  
-     * @param string $str       literal string
638  
-     * @param int    $pos       position to start at, beginning of string by default
  639
+     * @param string  $str       literal string
  640
+     * @param string  $substr    literal string to find
  641
+     * @param integer $startPos  position to start at, beginning of string by default
639 642
      * @return integer
640 643
      */
641 644
     public function getLocateExpression($str, $substr, $startPos = false)
@@ -699,6 +702,7 @@ public function getConcatExpression()
699 702
      *   ->where($e->eq('id', $e->not('null'));
700 703
      * </code>
701 704
      *
  705
+     * @param string $expression
702 706
      * @return string a logical expression
703 707
      */
704 708
     public function getNotExpression($expression)
@@ -715,8 +719,8 @@ public function getNotExpression($expression)
715 719
      * must contain a logical expression or an array with logical expressions.
716 720
      * These expressions will be matched against the first parameter.
717 721
      *
718  
-     * @param string $column        the value that should be matched against
719  
-     * @param string|array(string)  values that will be matched against $column
  722
+     * @param string $column                the value that should be matched against
  723
+     * @param string|array(string) $values  values that will be matched against $column
720 724
      * @return string logical expression
721 725
      */
722 726
     public function getInExpression($column, $values)
@@ -1209,7 +1213,7 @@ public function getAlterSequenceSQL(\Doctrine\DBAL\Schema\Sequence $sequence)
1209 1213
     /**
1210 1214
      * Gets the SQL to create a constraint on a table on this platform.
1211 1215
      *
1212  
-     * @param Constraint $constraint
  1216
+     * @param \Doctrine\DBAL\Schema\Constraint $constraint
1213 1217
      * @param string|Table $table
1214 1218
      * @return string
1215 1219
      */
@@ -1313,7 +1317,7 @@ public function getCreatePrimaryKeySQL(Index $index, $table)
1313 1317
     /**
1314 1318
      * Quotes a string so that it can be safely used as a table or column name,
1315 1319
      * even if it is a reserved word of the platform. This also detects identifier
1316  
-     * chains seperated by dot and quotes them independently.
  1320
+     * chains separated by dot and quotes them independently.
1317 1321
      *
1318 1322
      * NOTE: Just because you CAN use quoted identifiers doesn't mean
1319 1323
      * you SHOULD use them.  In general, they end up causing way more
@@ -1333,7 +1337,7 @@ public function quoteIdentifier($str)
1333 1337
     }
1334 1338
 
1335 1339
     /**
1336  
-     * Quote a single identifier (no dot chain seperation)
  1340
+     * Quote a single identifier (no dot chain separation)
1337 1341
      *
1338 1342
      * @param string $str
1339 1343
      * @return string
@@ -1380,6 +1384,7 @@ public function getAlterTableSQL(TableDiff $diff)
1380 1384
      * @param Column $column
1381 1385
      * @param TableDiff $diff
1382 1386
      * @param array $columnSql
  1387
+     * @return boolean
1383 1388
      */
1384 1389
     protected function onSchemaAlterTableAddColumn(Column $column, TableDiff $diff, &$columnSql)
1385 1390
     {
@@ -1403,6 +1408,7 @@ protected function onSchemaAlterTableAddColumn(Column $column, TableDiff $diff,
1403 1408
      * @param Column $column
1404 1409
      * @param TableDiff $diff
1405 1410
      * @param array $columnSql
  1411
+     * @return boolean
1406 1412
      */
1407 1413
     protected function onSchemaAlterTableRemoveColumn(Column $column, TableDiff $diff, &$columnSql)
1408 1414
     {
@@ -1426,6 +1432,7 @@ protected function onSchemaAlterTableRemoveColumn(Column $column, TableDiff $dif
1426 1432
      * @param ColumnDiff $columnDiff
1427 1433
      * @param TableDiff $diff
1428 1434
      * @param array $columnSql
  1435
+     * @return boolean
1429 1436
      */
1430 1437
     protected function onSchemaAlterTableChangeColumn(ColumnDiff $columnDiff, TableDiff $diff, &$columnSql)
1431 1438
     {
@@ -1450,6 +1457,7 @@ protected function onSchemaAlterTableChangeColumn(ColumnDiff $columnDiff, TableD
1450 1457
      * @param Column $column
1451 1458
      * @param TableDiff $diff
1452 1459
      * @param array $columnSql
  1460
+     * @return boolean
1453 1461
      */
1454 1462
     protected function onSchemaAlterTableRenameColumn($oldColumnName, Column $column, TableDiff $diff, &$columnSql)
1455 1463
     {
@@ -1470,7 +1478,8 @@ protected function onSchemaAlterTableRenameColumn($oldColumnName, Column $column
1470 1478
     }
1471 1479
     /**
1472 1480
      * @param TableDiff $diff
1473  
-     * @param array $columnSql
  1481
+     * @param array $qql
  1482
+     * @return boolean
1474 1483
      */
1475 1484
     protected function onSchemaAlterTable(TableDiff $diff, &$sql)
1476 1485
     {
@@ -1777,6 +1786,7 @@ public function getIndexDeclarationSQL($name, Index $index)
1777 1786
      * e.g. when a field has the "columnDefinition" keyword.
1778 1787
      * Only "AUTOINCREMENT" and "PRIMARY KEY" are added if appropriate.
1779 1788
      *
  1789
+     * @param array $columnDef
1780 1790
      * @return string
1781 1791
      */
1782 1792
     public function getCustomTypeDeclarationSQL(array $columnDef)
@@ -1789,6 +1799,7 @@ public function getCustomTypeDeclarationSQL(array $columnDef)
1789 1799
      * Obtain DBMS specific SQL code portion needed to set an index
1790 1800
      * declaration to be used in statements like CREATE TABLE.
1791 1801
      *
  1802
+     * @param array $fields
1792 1803
      * @return string
1793 1804
      */
1794 1805
     public function getIndexFieldDeclarationListSQL(array $fields)
@@ -1916,9 +1927,9 @@ public function getAdvancedForeignKeyOptionsSQL(ForeignKeyConstraint $foreignKey
1916 1927
      * returns given referential action in uppercase if valid, otherwise throws
1917 1928
      * an exception
1918 1929
      *
1919  
-     * @throws Doctrine_Exception_Exception     if unknown referential action given
  1930
+     * @throws \InvalidArgumentException if unknown referential action given
1920 1931
      * @param string $action    foreign key referential action
1921  
-     * @param string            foreign key referential action in uppercase
  1932
+     * @return string
1922 1933
      */
1923 1934
     public function getForeignKeyReferentialActionSQL($action)
1924 1935
     {
@@ -2035,6 +2046,7 @@ public function prefersIdentityColumns()
2035 2046
      * The default conversion in this implementation converts to integers (false => 0, true => 1).
2036 2047
      *
2037 2048
      * @param mixed $item
  2049
+     * @return mixed
2038 2050
      */
2039 2051
     public function convertBooleans($item)
2040 2052
     {
@@ -2572,7 +2584,7 @@ public function getSQLResultCasing($column)
2572 2584
      * Makes any fixes to a name of a schema element (table, sequence, ...) that are required
2573 2585
      * by restrictions of the platform, like a maximum length.
2574 2586
      *
2575  
-     * @param string $schemaName
  2587
+     * @param string $schemaElementName
2576 2588
      * @return string
2577 2589
      */
2578 2590
     public function fixSchemaElementName($schemaElementName)
2  lib/Doctrine/DBAL/Query/Expression/CompositeExpression.php
@@ -66,7 +66,7 @@ public function __construct($type, array $parts = array())
66 66
     /**
67 67
      * Adds multiple parts to composite expression.
68 68
      *
69  
-     * @param array $args
  69
+     * @param array $parts
70 70
      *
71 71
      * @return CompositeExpression
72 72
      */
2  lib/Doctrine/DBAL/Query/Expression/ExpressionBuilder.php
@@ -94,7 +94,7 @@ public function orX($x = null)
94 94
      * Creates a comparison expression.
95 95
      *
96 96
      * @param mixed $x Left expression
97  
-     * @param string $operator One of the ExpressionBuikder::* constants.
  97
+     * @param string $operator One of the ExpressionBuilder::* constants.
98 98
      * @param mixed $y Right expression
99 99
      * @return string
100 100
      */
14  lib/Doctrine/DBAL/Query/QueryBuilder.php
@@ -134,7 +134,7 @@ public function __construct(Connection $connection)
134 134
      * For more complex expression construction, consider storing the expression
135 135
      * builder object in a local variable.
136 136
      *
137  
-     * @return \Doctrine\DBAL\Query\ExpressionBuilder
  137
+     * @return \Doctrine\DBAL\Query\Expression\ExpressionBuilder
138 138
      */
139 139
     public function expr()
140 140
     {
@@ -271,6 +271,7 @@ public function setParameter($key, $value, $type = null)
271 271
      * </code>
272 272
      *
273 273
      * @param array $params The query parameters to set.
  274
+     * @param array $types  The query parameters types to set.
274 275
      * @return QueryBuilder This QueryBuilder instance.
275 276
      */
276 277
     public function setParameters(array $params, array $types = array())
@@ -356,9 +357,9 @@ public function getMaxResults()
356 357
      * The available parts are: 'select', 'from', 'set', 'where',
357 358
      * 'groupBy', 'having' and 'orderBy'.
358 359
      *
359  
-     * @param string $sqlPartName
360  
-     * @param string $sqlPart
361  
-     * @param string $append
  360
+     * @param string  $sqlPartName
  361
+     * @param string  $sqlPart
  362
+     * @param boolean $append
362 363
      * @return \Doctrine\DBAL\Query\QueryBuilder This QueryBuilder instance.
363 364
      */
364 365
     public function add($sqlPartName, $sqlPart, $append = false)
@@ -940,11 +941,6 @@ public function resetQueryPart($queryPartName)
940 941
         return $this;
941 942
     }
942 943
 
943  
-    /**
944  
-     * Converts this instance into a SELECT string in SQL.
945  
-     *
946  
-     * @return string
947  
-     */
948 944
     private function getSQLForSelect()
949 945
     {
950 946
         $query = 'SELECT ' . implode(', ', $this->sqlParts['select']) . ' FROM ';
1  lib/Doctrine/DBAL/SQLParserUtils.php
@@ -82,6 +82,7 @@ static public function getPlaceholderPositions($statement, $isPositional = true)
82 82
      * @param string $query
83 83
      * @param array $params
84 84
      * @param array $types
  85
+     * @return array
85 86
      */
86 87
     static public function expandListParameters($query, $params, $types)
87 88
     {
4  lib/Doctrine/DBAL/Schema/AbstractSchemaManager.php
@@ -68,7 +68,7 @@ public function __construct(\Doctrine\DBAL\Connection $conn)
68 68
     /**
69 69
      * Return associated platform.
70 70
      *
71  
-     * @return \Doctrine\DBAL\Platform\AbstractPlatform
  71
+     * @return \Doctrine\DBAL\Platforms\AbstractPlatform
72 72
      */
73 73
     public function getDatabasePlatform()
74 74
     {
@@ -497,7 +497,7 @@ public function dropAndCreateForeignKey(ForeignKeyConstraint $foreignKey, $table
497 497
      * Drop and create a new sequence
498 498
      *
499 499
      * @param Sequence $sequence
500  
-     * @throws Doctrine\DBAL\ConnectionException     if something fails at database level
  500
+     * @throws \Doctrine\DBAL\ConnectionException     if something fails at database level
501 501
      */
502 502
     public function dropAndCreateSequence(Sequence $sequence)
503 503
     {
13  lib/Doctrine/DBAL/Statement.php
@@ -43,15 +43,15 @@ class Statement implements \IteratorAggregate, DriverStatement
43 43
      */
44 44
     protected $params = array();
45 45
     /**
46  
-     * @var Doctrine\DBAL\Driver\Statement The underlying driver statement.
  46
+     * @var \Doctrine\DBAL\Driver\Statement The underlying driver statement.
47 47
      */
48 48
     protected $stmt;
49 49
     /**
50  
-     * @var Doctrine\DBAL\Platforms\AbstractPlatform The underlying database platform.
  50
+     * @var \Doctrine\DBAL\Platforms\AbstractPlatform The underlying database platform.
51 51
      */
52 52
     protected $platform;
53 53
     /**
54  
-     * @var Doctrine\DBAL\Connection The connection this statement is bound to and executed on.
  54
+     * @var \Doctrine\DBAL\Connection The connection this statement is bound to and executed on.
55 55
      */
56 56
     protected $conn;
57 57
 
@@ -77,8 +77,8 @@ public function __construct($sql, Connection $conn)
77 77
      * type and the value undergoes the conversion routines of the mapping type before
78 78
      * being bound.
79 79
      *
80  
-     * @param $name The name or position of the parameter.
81  
-     * @param $value The value of the parameter.
  80
+     * @param string $name The name or position of the parameter.
  81
+     * @param mixed $value The value of the parameter.
82 82
      * @param mixed $type Either a PDO binding type or a DBAL mapping type name or instance.
83 83
      * @return boolean TRUE on success, FALSE on failure.
84 84
      */
@@ -107,7 +107,7 @@ public function bindValue($name, $value, $type = null)
107 107
      * Binding a parameter by reference does not support DBAL mapping types.
108 108
      *
109 109
      * @param string $name The name or position of the parameter.
110  
-     * @param mixed $value The reference to the variable to bind
  110
+     * @param mixed $var The reference to the variable to bind
111 111
      * @param integer $type The PDO binding type.
112 112
      * @return boolean TRUE on success, FALSE on failure.
113 113
      */
@@ -119,6 +119,7 @@ public function bindParam($name, &$var, $type = PDO::PARAM_STR)
119 119
     /**
120 120
      * Executes the statement with the currently bound parameters.
121 121
      *
  122
+     * @param array $params
122 123
      * @return boolean TRUE on success, FALSE on failure.
123 124
      */
124 125
     public function execute($params = null)
Commit_comment_tip

Tip: You can add notes to lines in a file. Hover to the left of a line to make a note

Something went wrong with that request. Please try again.