Skip to content

Corrected fluent interface docblock annotations. #1370

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 1, 2016
Merged

Corrected fluent interface docblock annotations. #1370

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0575ead
Corrected fluent interface docblock annotations.
Bilge Feb 29, 2016
fda9592
Fixed @return docblock annotations in Query\Builder.
Bilge Feb 29, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions lib/Doctrine/ODM/MongoDB/Cursor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ public function getQuery()
* @see http://php.net/manual/en/mongocursor.addoption.php
* @param string $key
* @param mixed $value
* @return self
* @return $this
*/
public function addOption($key, $value)
{
Expand All @@ -206,7 +206,7 @@ public function addOption($key, $value)
* @see CursorInterface::batchSize()
* @see http://php.net/manual/en/mongocursor.batchsize.php
* @param integer $num
* @return self
* @return $this
*/
public function batchSize($num)
{
Expand Down Expand Up @@ -276,7 +276,7 @@ public function explain()
*
* @see CursorInterface::fields()
* @see http://php.net/manual/en/mongocursor.fields.php
* @return self
* @return $this
*/
public function fields(array $f)
{
Expand Down Expand Up @@ -319,7 +319,7 @@ public function getReadPreference()
* @see http://php.net/manual/en/mongocursor.setreadpreference.php
* @param string $readPreference
* @param array $tags
* @return self
* @return $this
*/
public function setReadPreference($readPreference, array $tags = null)
{
Expand Down Expand Up @@ -381,7 +381,7 @@ public function hasNext()
* @see CursorInterface::hint()
* @see http://php.net/manual/en/mongocursor.hint.php
* @param array|string $keyPattern
* @return self
* @return $this
*/
public function hint($keyPattern)
{
Expand All @@ -393,7 +393,7 @@ public function hint($keyPattern)
* Set whether to hydrate results as document class instances.
*
* @param boolean $hydrate
* @return self
* @return $this
*/
public function hydrate($hydrate = true)
{
Expand All @@ -420,7 +420,7 @@ private function hydrateDocument($document)
* @see CursorInterface::immortal()
* @see http://php.net/manual/en/mongocursor.immortal.php
* @param boolean $liveForever
* @return self
* @return $this
*/
public function immortal($liveForever = true)
{
Expand Down Expand Up @@ -459,7 +459,7 @@ public function key()
* @see CursorInterface::limit()
* @see http://php.net/manual/en/mongocursor.limit.php
* @param integer $num
* @return self
* @return $this
*/
public function limit($num)
{
Expand Down Expand Up @@ -496,7 +496,7 @@ public function recreate()
* This option has no effect if hydration is disabled.
*
* @param boolean $refresh
* @return self
* @return $this
*/
public function refresh($refresh = true)
{
Expand Down Expand Up @@ -534,7 +534,7 @@ public function rewind()
* @see CursorInterface::skip()
* @see http://php.net/manual/en/mongocursor.skip.php
* @param integer $num
* @return self
* @return $this
*/
public function skip($num)
{
Expand All @@ -548,7 +548,7 @@ public function skip($num)
* @see CursorInterface::slaveOkay()
* @see http://php.net/manual/en/mongocursor.slaveokay.php
* @param boolean $ok
* @return self
* @return $this
*/
public function slaveOkay($ok = true)
{
Expand All @@ -563,7 +563,7 @@ public function slaveOkay($ok = true)
*
* @see CursorInterface::snapshot()
* @see http://php.net/manual/en/mongocursor.snapshot.php
* @return self
* @return $this
*/
public function snapshot()
{
Expand All @@ -579,7 +579,7 @@ public function snapshot()
* @see CursorInterface::sort()
* @see http://php.net/manual/en/mongocursor.sort.php
* @param array $fields
* @return self
* @return $this
*/
public function sort($fields)
{
Expand All @@ -597,7 +597,7 @@ public function sort($fields)
* @see CursorInterface::tailable()
* @see http://php.net/manual/en/mongocursor.tailable.php
* @param boolean $tail
* @return self
* @return $this
*/
public function tailable($tail = true)
{
Expand All @@ -611,7 +611,7 @@ public function tailable($tail = true)
* @see CursorInterface::timeout()
* @see http://php.net/manual/en/mongocursor.timeout.php
* @param integer $ms
* @return self
* @return $this
*/
public function timeout($ms)
{
Expand Down Expand Up @@ -664,7 +664,7 @@ public function valid()
/**
* @param array $primers
* @param ReferencePrimer $referencePrimer
* @return self
* @return $this
*/
public function enableReferencePriming(array $primers, ReferencePrimer $referencePrimer)
{
Expand Down
28 changes: 14 additions & 14 deletions lib/Doctrine/ODM/MongoDB/Query/Builder.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ public function __construct(DocumentManager $dm, $documentName = null)
* Set whether or not to require indexes.
*
* @param bool $requireIndexes
* @return Builder
* @return $this
*/
public function requireIndexes($requireIndexes = true)
{
Expand All @@ -113,7 +113,7 @@ public function requireIndexes($requireIndexes = true)
* Set the current field to operate on.
*
* @param string $field
* @return self
* @return $this
*/
public function field($field)
{
Expand All @@ -138,7 +138,7 @@ public function field($field)
* Closure defined in {@link ReferencePrimer::__construct()}.
*
* @param boolean|callable $primer
* @return Builder
* @return $this
* @throws \InvalidArgumentException If $primer is not boolean or callable
*/
public function prime($primer = true)
Expand Down Expand Up @@ -176,7 +176,7 @@ public function eagerCursor($bool = true)

/**
* @param bool $bool
* @return Builder
* @return $this
*/
public function hydrate($bool = true)
{
Expand All @@ -186,7 +186,7 @@ public function hydrate($bool = true)

/**
* @param bool $bool
* @return Builder
* @return $this
*/
public function refresh($bool = true)
{
Expand All @@ -198,7 +198,7 @@ public function refresh($bool = true)
* Change the query type to find and optionally set and change the class being queried.
*
* @param string $documentName
* @return Builder
* @return $this
*/
public function find($documentName = null)
{
Expand All @@ -210,7 +210,7 @@ public function find($documentName = null)

/**
* @param string $documentName
* @return Builder
* @return $this
*/
public function findAndUpdate($documentName = null)
{
Expand All @@ -222,7 +222,7 @@ public function findAndUpdate($documentName = null)

/**
* @param bool $bool
* @return self
* @return $this
*/
public function returnNew($bool = true)
{
Expand All @@ -234,7 +234,7 @@ public function returnNew($bool = true)

/**
* @param string $documentName
* @return Builder
* @return $this
*/
public function findAndRemove($documentName = null)
{
Expand All @@ -246,7 +246,7 @@ public function findAndRemove($documentName = null)

/**
* @param string $documentName
* @return Builder
* @return $this
*/
public function update($documentName = null)
{
Expand All @@ -258,7 +258,7 @@ public function update($documentName = null)

/**
* @param string $documentName
* @return Builder
* @return $this
*/
public function insert($documentName = null)
{
Expand All @@ -270,7 +270,7 @@ public function insert($documentName = null)

/**
* @param string $documentName
* @return Builder
* @return $this
*/
public function remove($documentName = null)
{
Expand All @@ -282,7 +282,7 @@ public function remove($documentName = null)

/**
* @param object $document
* @return Builder
* @return $this
*/
public function references($document)
{
Expand All @@ -292,7 +292,7 @@ public function references($document)

/**
* @param object $document
* @return Builder
* @return $this
*/
public function includesReferenceTo($document)
{
Expand Down