Query Builder documentation needs return information

[Doggie52]

The documentation for the Query Builder needs information on what the various functions return in different scenarios (success/failure).

[Doggie52]

Unsure if there are other parts of the database documentation that need this information too, but there most likely are.

[Doggie52]

Yes, the documentation I referred to was in fact the one in this repo and not the 2.1.3 one. I'll take a look and see what I can do.

I've asked around briefly on IRC and nobody seems quite sure about the precise return values. I can simulate a successful database write and var_dump() it but I'm not quite sure how to simulate an unsuccessful one. I'll take a look at the source code directly and see what secrets it reveals.

[AkenRoberts]

Anything you need to know about return values is in the source code.

[GDmac]

Most query 'building' methods return $this (the query builder object) to be able to chain those methods. Generally, when the query has been 'build', then the query is excecuted with one of the query excecuting methods e.g. insert(), update(),replace(), delete(), etc. Most return a result object, but indeed can return a boolean or query-string as well, which should be better documented.

$query = $this->db
   ->select('fieldname') // returns $this
   ->from('tablename') // same
   ->limit(5) // also returns $this
   ->get(); // returns result set

[jim-parry]

I will go through the database docs ... there could be room for improvement!

ps Not sure whether to consider documentation changes a bug or a feature, hence the waffling on the labels :-/

[narfbg]

It's neither.