| Index: trunk/phase3/includes/db/Database.php |
| — | — | @@ -2494,7 +2494,7 @@ |
| 2495 | 2495 | /** |
| 2496 | 2496 | * Read and execute commands from an open file handle |
| 2497 | 2497 | * Returns true on success, error string or exception on failure (depending on object's error ignore settings) |
| 2498 | | - * @param $fp String: File handle |
| | 2498 | + * @param $fp Resource: File handle |
| 2499 | 2499 | * @param $lineCallback Callback: Optional function called before reading each line |
| 2500 | 2500 | * @param $resultCallback Callback: Optional function called for each MySQL result |
| 2501 | 2501 | * @param $fname String: Calling function name |
| — | — | @@ -3124,6 +3124,9 @@ |
| 3125 | 3125 | |
| 3126 | 3126 | /** |
| 3127 | 3127 | * Create a new result object from a result resource and a Database object |
| | 3128 | + * |
| | 3129 | + * @param Database $database |
| | 3130 | + * @param resource $result |
| 3128 | 3131 | */ |
| 3129 | 3132 | function __construct( $database, $result ) { |
| 3130 | 3133 | $this->db = $database; |
| — | — | @@ -3137,6 +3140,8 @@ |
| 3138 | 3141 | |
| 3139 | 3142 | /** |
| 3140 | 3143 | * Get the number of rows in a result object |
| | 3144 | + * |
| | 3145 | + * @return integer |
| 3141 | 3146 | */ |
| 3142 | 3147 | function numRows() { |
| 3143 | 3148 | return $this->db->numRows( $this ); |
| — | — | @@ -3175,8 +3180,10 @@ |
| 3176 | 3181 | } |
| 3177 | 3182 | |
| 3178 | 3183 | /** |
| 3179 | | - * Change the position of the cursor in a result object |
| | 3184 | + * Change the position of the cursor in a result object. |
| 3180 | 3185 | * See mysql_data_seek() |
| | 3186 | + * |
| | 3187 | + * @param $row integer |
| 3181 | 3188 | */ |
| 3182 | 3189 | function seek( $row ) { |
| 3183 | 3190 | $this->db->dataSeek( $this, $row ); |
| — | — | @@ -3266,10 +3273,20 @@ |
| 3267 | 3274 | class LikeMatch { |
| 3268 | 3275 | private $str; |
| 3269 | 3276 | |
| | 3277 | + /** |
| | 3278 | + * Store a string into a LikeMatch marker object. |
| | 3279 | + * |
| | 3280 | + * @param String $s |
| | 3281 | + */ |
| 3270 | 3282 | public function __construct( $s ) { |
| 3271 | 3283 | $this->str = $s; |
| 3272 | 3284 | } |
| 3273 | 3285 | |
| | 3286 | + /** |
| | 3287 | + * Return the original stored string. |
| | 3288 | + * |
| | 3289 | + * @return String |
| | 3290 | + */ |
| 3274 | 3291 | public function toString() { |
| 3275 | 3292 | return $this->str; |
| 3276 | 3293 | } |