Skip to content

Commit

Permalink
Merge pull request doctrine#2349 from mrclay/self
Browse files Browse the repository at this point in the history 
Fluent methods in QueryBuilder are now documented as returning `self`
  • Loading branch information
@Ocramius
Ocramius committed Apr 3, 2016
2 parents 61e1f86 + f7f8f24 commit 3df22cc
Showing 1 changed file with 30 additions and 30 deletions.
60 changes: 30 additions & 30 deletions lib/Doctrine/DBAL/Query/QueryBuilder.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@ public function getSQL()
* @param mixed $value The parameter value.
* @param string|null $type One of the PDO::PARAM_* constants.
*
* @return \Doctrine\DBAL\Query\QueryBuilder This QueryBuilder instance.
* @return self This QueryBuilder instance.
*/
public function setParameter($key, $value, $type = null)
{
Expand Down Expand Up @@ -296,7 +296,7 @@ public function setParameter($key, $value, $type = null)
* @param array $params The query parameters to set.
* @param array $types The query parameters types to set.
*
* @return \Doctrine\DBAL\Query\QueryBuilder This QueryBuilder instance.
* @return self This QueryBuilder instance.
*/
public function setParameters(array $params, array $types = array())
{
Expand Down Expand Up @@ -355,7 +355,7 @@ public function getParameterType($key)
*
* @param integer $firstResult The first result to return.
*
* @return \Doctrine\DBAL\Query\QueryBuilder This QueryBuilder instance.
* @return self This QueryBuilder instance.
*/
public function setFirstResult($firstResult)
{
Expand All @@ -381,7 +381,7 @@ public function getFirstResult()
*
* @param integer $maxResults The maximum number of results to retrieve.
*
* @return \Doctrine\DBAL\Query\QueryBuilder This QueryBuilder instance.
* @return self This QueryBuilder instance.
*/
public function setMaxResults($maxResults)
{
Expand Down Expand Up @@ -412,7 +412,7 @@ public function getMaxResults()
* @param string $sqlPart
* @param boolean $append
*
* @return \Doctrine\DBAL\Query\QueryBuilder This QueryBuilder instance.
* @return self This QueryBuilder instance.
*/
public function add($sqlPartName, $sqlPart, $append = false)
{
Expand Down Expand Up @@ -460,7 +460,7 @@ public function add($sqlPartName, $sqlPart, $append = false)
*
* @param mixed $select The selection expressions.
*
* @return \Doctrine\DBAL\Query\QueryBuilder This QueryBuilder instance.
* @return self This QueryBuilder instance.
*/
public function select($select = null)
{
Expand Down Expand Up @@ -488,7 +488,7 @@ public function select($select = null)
*
* @param mixed $select The selection expression.
*
* @return \Doctrine\DBAL\Query\QueryBuilder This QueryBuilder instance.
* @return self This QueryBuilder instance.
*/
public function addSelect($select = null)
{
Expand Down Expand Up @@ -517,7 +517,7 @@ public function addSelect($select = null)
* @param string $delete The table whose rows are subject to the deletion.
* @param string $alias The table alias used in the constructed query.
*
* @return \Doctrine\DBAL\Query\QueryBuilder This QueryBuilder instance.
* @return self This QueryBuilder instance.
*/
public function delete($delete = null, $alias = null)
{
Expand Down Expand Up @@ -547,7 +547,7 @@ public function delete($delete = null, $alias = null)
* @param string $update The table whose rows are subject to the update.
* @param string $alias The table alias used in the constructed query.
*
* @return \Doctrine\DBAL\Query\QueryBuilder This QueryBuilder instance.
* @return self This QueryBuilder instance.
*/
public function update($update = null, $alias = null)
{
Expand Down Expand Up @@ -580,7 +580,7 @@ public function update($update = null, $alias = null)
*
* @param string $insert The table into which the rows should be inserted.
*
* @return QueryBuilder This QueryBuilder instance.
* @return self This QueryBuilder instance.
*/
public function insert($insert = null)
{
Expand Down Expand Up @@ -608,7 +608,7 @@ public function insert($insert = null)
* @param string $from The table.
* @param string|null $alias The alias of the table.
*
* @return QueryBuilder This QueryBuilder instance.
* @return self This QueryBuilder instance.
*/
public function from($from, $alias = null)
{
Expand All @@ -633,7 +633,7 @@ public function from($from, $alias = null)
* @param string $alias The alias of the join table.
* @param string $condition The condition for the join.
*
* @return \Doctrine\DBAL\Query\QueryBuilder This QueryBuilder instance.
* @return self This QueryBuilder instance.
*/
public function join($fromAlias, $join, $alias, $condition = null)
{
Expand All @@ -655,7 +655,7 @@ public function join($fromAlias, $join, $alias, $condition = null)
* @param string $alias The alias of the join table.
* @param string $condition The condition for the join.
*
* @return \Doctrine\DBAL\Query\QueryBuilder This QueryBuilder instance.
* @return self This QueryBuilder instance.
*/
public function innerJoin($fromAlias, $join, $alias, $condition = null)
{
Expand Down Expand Up @@ -684,7 +684,7 @@ public function innerJoin($fromAlias, $join, $alias, $condition = null)
* @param string $alias The alias of the join table.
* @param string $condition The condition for the join.
*
* @return \Doctrine\DBAL\Query\QueryBuilder This QueryBuilder instance.
* @return self This QueryBuilder instance.
*/
public function leftJoin($fromAlias, $join, $alias, $condition = null)
{
Expand Down Expand Up @@ -713,7 +713,7 @@ public function leftJoin($fromAlias, $join, $alias, $condition = null)
* @param string $alias The alias of the join table.
* @param string $condition The condition for the join.
*
* @return \Doctrine\DBAL\Query\QueryBuilder This QueryBuilder instance.
* @return self This QueryBuilder instance.
*/
public function rightJoin($fromAlias, $join, $alias, $condition = null)
{
Expand All @@ -740,7 +740,7 @@ public function rightJoin($fromAlias, $join, $alias, $condition = null)
* @param string $key The column to set.
* @param string $value The value, expression, placeholder, etc.
*
* @return \Doctrine\DBAL\Query\QueryBuilder This QueryBuilder instance.
* @return self This QueryBuilder instance.
*/
public function set($key, $value)
{
Expand Down Expand Up @@ -771,7 +771,7 @@ public function set($key, $value)
*
* @param mixed $predicates The restriction predicates.
*
* @return \Doctrine\DBAL\Query\QueryBuilder This QueryBuilder instance.
* @return self This QueryBuilder instance.
*/
public function where($predicates)
{
Expand All @@ -796,7 +796,7 @@ public function where($predicates)
*
* @param mixed $where The query restrictions.
*
* @return \Doctrine\DBAL\Query\QueryBuilder This QueryBuilder instance.
* @return self This QueryBuilder instance.
*
* @see where()
*/
Expand Down Expand Up @@ -829,7 +829,7 @@ public function andWhere($where)
*
* @param mixed $where The WHERE statement.
*
* @return \Doctrine\DBAL\Query\QueryBuilder This QueryBuilder instance.
* @return self This QueryBuilder instance.
*
* @see where()
*/
Expand Down Expand Up @@ -861,7 +861,7 @@ public function orWhere($where)
*
* @param mixed $groupBy The grouping expression.
*
* @return \Doctrine\DBAL\Query\QueryBuilder This QueryBuilder instance.
* @return self This QueryBuilder instance.
*/
public function groupBy($groupBy)
{
Expand All @@ -888,7 +888,7 @@ public function groupBy($groupBy)
*
* @param mixed $groupBy The grouping expression.
*
* @return \Doctrine\DBAL\Query\QueryBuilder This QueryBuilder instance.
* @return self This QueryBuilder instance.
*/
public function addGroupBy($groupBy)
{
Expand Down Expand Up @@ -918,7 +918,7 @@ public function addGroupBy($groupBy)
* @param string $column The column into which the value should be inserted.
* @param string $value The value that should be inserted into the column.
*
* @return QueryBuilder This QueryBuilder instance.
* @return self This QueryBuilder instance.
*/
public function setValue($column, $value)
{
Expand All @@ -944,7 +944,7 @@ public function setValue($column, $value)
*
* @param array $values The values to specify for the insert query indexed by column names.
*
* @return QueryBuilder This QueryBuilder instance.
* @return self This QueryBuilder instance.
*/
public function values(array $values)
{
Expand All @@ -957,7 +957,7 @@ public function values(array $values)
*
* @param mixed $having The restriction over the groups.
*
* @return \Doctrine\DBAL\Query\QueryBuilder This QueryBuilder instance.
* @return self This QueryBuilder instance.
*/
public function having($having)
{
Expand All @@ -974,7 +974,7 @@ public function having($having)
*
* @param mixed $having The restriction to append.
*
* @return \Doctrine\DBAL\Query\QueryBuilder This QueryBuilder instance.
* @return self This QueryBuilder instance.
*/
public function andHaving($having)
{
Expand All @@ -997,7 +997,7 @@ public function andHaving($having)
*
* @param mixed $having The restriction to add.
*
* @return \Doctrine\DBAL\Query\QueryBuilder This QueryBuilder instance.
* @return self This QueryBuilder instance.
*/
public function orHaving($having)
{
Expand All @@ -1021,7 +1021,7 @@ public function orHaving($having)
* @param string $sort The ordering expression.
* @param string $order The ordering direction.
*
* @return \Doctrine\DBAL\Query\QueryBuilder This QueryBuilder instance.
* @return self This QueryBuilder instance.
*/
public function orderBy($sort, $order = null)
{
Expand All @@ -1034,7 +1034,7 @@ public function orderBy($sort, $order = null)
* @param string $sort The ordering expression.
* @param string $order The ordering direction.
*
* @return \Doctrine\DBAL\Query\QueryBuilder This QueryBuilder instance.
* @return self This QueryBuilder instance.
*/
public function addOrderBy($sort, $order = null)
{
Expand Down Expand Up @@ -1068,7 +1068,7 @@ public function getQueryParts()
*
* @param array|null $queryPartNames
*
* @return \Doctrine\DBAL\Query\QueryBuilder This QueryBuilder instance.
* @return self This QueryBuilder instance.
*/
public function resetQueryParts($queryPartNames = null)
{
Expand All @@ -1088,7 +1088,7 @@ public function resetQueryParts($queryPartNames = null)
*
* @param string $queryPartName
*
* @return \Doctrine\DBAL\Query\QueryBuilder This QueryBuilder instance.
* @return self This QueryBuilder instance.
*/
public function resetQueryPart($queryPartName)
{
Expand Down

0 comments on commit 3df22cc

Please sign in to comment.