Browse Source

Merge pull request #2699 from bcrowe/3.0-resultset

3.0 - Add additional interface notes, correct typo
Mark Story 12 years ago
parent
commit
80ab6f9b95
1 changed files with 12 additions and 2 deletions
  1. 12 2
      src/ORM/ResultSet.php

+ 12 - 2
src/ORM/ResultSet.php

@@ -36,7 +36,7 @@ class ResultSet implements Countable, Iterator, Serializable, JsonSerializable {
 	use CollectionTrait;
 
 /**
- * Original query from where results where generated
+ * Original query from where results were generated
  *
  * @var Query
  */
@@ -133,6 +133,8 @@ class ResultSet implements Countable, Iterator, Serializable, JsonSerializable {
 /**
  * Returns the current record in the result iterator
  *
+ * Part of Iterator interface.
+ *
  * @return array|object
  */
 	public function current() {
@@ -142,6 +144,8 @@ class ResultSet implements Countable, Iterator, Serializable, JsonSerializable {
 /**
  * Returns the key of the current record in the iterator
  *
+ * Part of Iterator interface.
+ *
  * @return integer
  */
 	public function key() {
@@ -151,6 +155,8 @@ class ResultSet implements Countable, Iterator, Serializable, JsonSerializable {
 /**
  * Advances the iterator pointer to the next record
  *
+ * Part of Iterator interface.
+ *
  * @return void
  */
 	public function next() {
@@ -160,6 +166,8 @@ class ResultSet implements Countable, Iterator, Serializable, JsonSerializable {
 /**
  * Rewind a ResultSet.
  *
+ * Part of Iterator interface.
+ *
  * @throws Cake\Database\Exception
  * @return void
  */
@@ -179,6 +187,8 @@ class ResultSet implements Countable, Iterator, Serializable, JsonSerializable {
 /**
  * Whether there are more results to be fetched from the iterator
  *
+ * Part of Iterator interface.
+ *
  * @return boolean
  */
 	public function valid() {
@@ -257,7 +267,7 @@ class ResultSet implements Countable, Iterator, Serializable, JsonSerializable {
 /**
  * Gives the number of rows in the result set.
  *
- * Part of the countable interface.
+ * Part of the Countable interface.
  *
  * @return integer
  */