@@ -14,7 +14,7 @@ |
||
| 14 | 14 | |
| 15 | 15 | /** |
| 16 | 16 | * Creates a copy whether in PHP5 or PHP4. |
| 17 | - * @param object $object Thing to copy. |
|
| 17 | + * @param SimpleFormTag $object Thing to copy. |
|
| 18 | 18 | * @return object A copy. |
| 19 | 19 | * @access public |
| 20 | 20 | * @static |
@@ -239,8 +239,6 @@ |
||
| 239 | 239 | /** |
| 240 | 240 | * Removes expired and temporary cookies as if |
| 241 | 241 | * the browser was closed and re-opened. |
| 242 | - * @param string/integer $now Time to test expiry against. |
|
| 243 | - * @access public |
|
| 244 | 242 | */ |
| 245 | 243 | function restartSession($date = false) { |
| 246 | 244 | $surviving_cookies = array(); |
@@ -248,7 +248,7 @@ |
||
| 248 | 248 | * form encoded packet. |
| 249 | 249 | * @param string $key Key to add value to. |
| 250 | 250 | * @param string $content Raw data. |
| 251 | - * @param hash $filename Original filename. |
|
| 251 | + * @param string $filename Original filename. |
|
| 252 | 252 | * @access public |
| 253 | 253 | */ |
| 254 | 254 | function attach($key, $content, $filename) { |
@@ -87,8 +87,7 @@ discard block |
||
| 87 | 87 | * Combined action attribute with current location |
| 88 | 88 | * to get an absolute form target. |
| 89 | 89 | * @param string $action Action attribute from form tag. |
| 90 | - * @param SimpleUrl $base Page location. |
|
| 91 | - * @return SimpleUrl Absolute form target. |
|
| 90 | + * @param SimplePage $page |
|
| 92 | 91 | */ |
| 93 | 92 | function _createAction($action, &$page) { |
| 94 | 93 | if (($action === '') || ($action === false)) { |
@@ -221,7 +220,7 @@ discard block |
||
| 221 | 220 | |
| 222 | 221 | /** |
| 223 | 222 | * Sets a widget value within the form. |
| 224 | - * @param SimpleSelector $selector Criteria to apply. |
|
| 223 | + * @param SimpleByName $selector Criteria to apply. |
|
| 225 | 224 | * @param string $value Value to input into the widget. |
| 226 | 225 | * @return boolean True if value is legal, false |
| 227 | 226 | * otherwise. If the field is not |
@@ -293,7 +292,7 @@ discard block |
||
| 293 | 292 | |
| 294 | 293 | /** |
| 295 | 294 | * Gets the submit values for a selected button. |
| 296 | - * @param SimpleSelector $selector Criteria to apply. |
|
| 295 | + * @param SimpleByName $selector Criteria to apply. |
|
| 297 | 296 | * @param hash $additional Additional data for the form. |
| 298 | 297 | * @return SimpleEncoding Submitted values or false |
| 299 | 298 | * if there is no such button |
@@ -135,9 +135,6 @@ discard block |
||
| 135 | 135 | /** |
| 136 | 136 | * Creates the first line which is the actual request. |
| 137 | 137 | * @param string $method HTTP request method, usually GET. |
| 138 | - * @param SimpleUrl $url URL as object. |
|
| 139 | - * @return string Request line content. |
|
| 140 | - * @access protected |
|
| 141 | 138 | */ |
| 142 | 139 | function _getRequestLine($method) { |
| 143 | 140 | $url = $this->getUrl(); |
@@ -149,9 +146,6 @@ discard block |
||
| 149 | 146 | |
| 150 | 147 | /** |
| 151 | 148 | * Creates the host part of the request. |
| 152 | - * @param SimpleUrl $url URL as object. |
|
| 153 | - * @return string Host line content. |
|
| 154 | - * @access protected |
|
| 155 | 149 | */ |
| 156 | 150 | function _getHostLine() { |
| 157 | 151 | $host = 'Host: ' . $this->_proxy->getHost(); |
@@ -235,10 +229,6 @@ discard block |
||
| 235 | 229 | /** |
| 236 | 230 | * Sends the headers. |
| 237 | 231 | * @param SimpleSocket $socket Open socket. |
| 238 | - * @param string $method HTTP request method, |
|
| 239 | - * usually GET. |
|
| 240 | - * @param SimpleFormEncoding $encoding Content to send with request. |
|
| 241 | - * @access private |
|
| 242 | 232 | */ |
| 243 | 233 | function _dispatchRequest(&$socket, $encoding) { |
| 244 | 234 | foreach ($this->_headers as $header_line) { |
@@ -323,7 +313,7 @@ discard block |
||
| 323 | 313 | |
| 324 | 314 | /** |
| 325 | 315 | * Accessor for parsed HTTP protocol version. |
| 326 | - * @return integer HTTP error code. |
|
| 316 | + * @return false|string HTTP error code. |
|
| 327 | 317 | * @access public |
| 328 | 318 | */ |
| 329 | 319 | function getHttpVersion() { |
@@ -565,7 +555,7 @@ discard block |
||
| 565 | 555 | /** |
| 566 | 556 | * Accessor for the content after the last |
| 567 | 557 | * header line. |
| 568 | - * @return string All content. |
|
| 558 | + * @return boolean All content. |
|
| 569 | 559 | * @access public |
| 570 | 560 | */ |
| 571 | 561 | function getContent() { |
@@ -575,7 +565,7 @@ discard block |
||
| 575 | 565 | /** |
| 576 | 566 | * Accessor for header block. The response is the |
| 577 | 567 | * combination of this and the content. |
| 578 | - * @return SimpleHeaders Wrapped header block. |
|
| 568 | + * @return SimpleHttpHeaders Wrapped header block. |
|
| 579 | 569 | * @access public |
| 580 | 570 | */ |
| 581 | 571 | function getHeaders() { |
@@ -145,7 +145,7 @@ discard block |
||
| 145 | 145 | /** |
| 146 | 146 | * Reads the raw content and send events |
| 147 | 147 | * into the page to be built. |
| 148 | - * @param $response SimpleHttpResponse Fetched response. |
|
| 148 | + * @param TestSession_STResponseWrapper $response SimpleHttpResponse Fetched response. |
|
| 149 | 149 | * @return SimplePage Newly parsed page. |
| 150 | 150 | * @access public |
| 151 | 151 | */ |
@@ -170,8 +170,8 @@ discard block |
||
| 170 | 170 | |
| 171 | 171 | /** |
| 172 | 172 | * Creates the parser used with the builder. |
| 173 | - * @param $listener SimpleSaxListener Target of parser. |
|
| 174 | - * @return SimpleSaxParser Parser to generate |
|
| 173 | + * @param SimplePageBuilder $listener SimpleSaxListener Target of parser. |
|
| 174 | + * @return SimpleHtmlSaxParser Parser to generate |
|
| 175 | 175 | * events for the builder. |
| 176 | 176 | * @access protected |
| 177 | 177 | */ |
@@ -406,7 +406,7 @@ discard block |
||
| 406 | 406 | |
| 407 | 407 | /** |
| 408 | 408 | * Original request as bytes sent down the wire. |
| 409 | - * @return mixed Sent content. |
|
| 409 | + * @return string|false Sent content. |
|
| 410 | 410 | * @access public |
| 411 | 411 | */ |
| 412 | 412 | function getRequest() { |
@@ -415,7 +415,7 @@ discard block |
||
| 415 | 415 | |
| 416 | 416 | /** |
| 417 | 417 | * Accessor for raw text of page. |
| 418 | - * @return string Raw unparsed content. |
|
| 418 | + * @return boolean Raw unparsed content. |
|
| 419 | 419 | * @access public |
| 420 | 420 | */ |
| 421 | 421 | function getRaw() { |
@@ -467,7 +467,7 @@ discard block |
||
| 467 | 467 | |
| 468 | 468 | /** |
| 469 | 469 | * Base URL if set via BASE tag page url otherwise |
| 470 | - * @return SimpleUrl Base url. |
|
| 470 | + * @return boolean Base url. |
|
| 471 | 471 | * @access public |
| 472 | 472 | */ |
| 473 | 473 | function getBaseUrl() { |
@@ -658,7 +658,7 @@ discard block |
||
| 658 | 658 | /** |
| 659 | 659 | * Opens a frameset. A frameset may contain nested |
| 660 | 660 | * frameset tags. |
| 661 | - * @param SimpleFramesetTag $tag Tag to accept. |
|
| 661 | + * @param SimpleTag $tag Tag to accept. |
|
| 662 | 662 | * @access public |
| 663 | 663 | */ |
| 664 | 664 | function acceptFramesetStart(&$tag) { |
@@ -90,8 +90,6 @@ discard block |
||
| 90 | 90 | * regular expression separated with the |
| 91 | 91 | * "or" operator. Caches the regex. |
| 92 | 92 | * Will automatically escape (, ) and / tokens. |
| 93 | - * @param array $patterns List of patterns in order. |
|
| 94 | - * @access private |
|
| 95 | 93 | */ |
| 96 | 94 | function _getCompoundedRegex() { |
| 97 | 95 | if ($this->_regex == null) { |
@@ -468,7 +466,7 @@ discard block |
||
| 468 | 466 | |
| 469 | 467 | /** |
| 470 | 468 | * List of parsed tags. Others are ignored. |
| 471 | - * @return array List of searched for tags. |
|
| 469 | + * @return string[] List of searched for tags. |
|
| 472 | 470 | * @access private |
| 473 | 471 | */ |
| 474 | 472 | function _getParsedTags() { |
@@ -573,7 +571,7 @@ discard block |
||
| 573 | 571 | |
| 574 | 572 | /** |
| 575 | 573 | * Sets up the matching lexer. Starts in 'text' mode. |
| 576 | - * @param SimpleSaxParser $parser Event generator, usually $self. |
|
| 574 | + * @param SimpleHtmlSaxParser $parser Event generator, usually $self. |
|
| 577 | 575 | * @return SimpleLexer Lexer suitable for this parser. |
| 578 | 576 | * @access public |
| 579 | 577 | * @static |
@@ -591,7 +589,7 @@ discard block |
||
| 591 | 589 | * name is converted to lower case. |
| 592 | 590 | * @param string $token Incoming characters. |
| 593 | 591 | * @param integer $event Lexer event type. |
| 594 | - * @return boolean False if parse error. |
|
| 592 | + * @return boolean|null False if parse error. |
|
| 595 | 593 | * @access public |
| 596 | 594 | */ |
| 597 | 595 | function acceptStartToken($token, $event) { |
@@ -619,7 +617,7 @@ discard block |
||
| 619 | 617 | * The element name is converted to lower case. |
| 620 | 618 | * @param string $token Incoming characters. |
| 621 | 619 | * @param integer $event Lexer event type. |
| 622 | - * @return boolean False if parse error. |
|
| 620 | + * @return boolean|null False if parse error. |
|
| 623 | 621 | * @access public |
| 624 | 622 | */ |
| 625 | 623 | function acceptEndToken($token, $event) { |
@@ -654,7 +652,7 @@ discard block |
||
| 654 | 652 | * A character entity. |
| 655 | 653 | * @param string $token Incoming characters. |
| 656 | 654 | * @param integer $event Lexer event type. |
| 657 | - * @return boolean False if parse error. |
|
| 655 | + * @return boolean|null False if parse error. |
|
| 658 | 656 | * @access public |
| 659 | 657 | */ |
| 660 | 658 | function acceptEntityToken($token, $event) { |
@@ -665,7 +663,7 @@ discard block |
||
| 665 | 663 | * important. |
| 666 | 664 | * @param string $token Incoming characters. |
| 667 | 665 | * @param integer $event Lexer event type. |
| 668 | - * @return boolean False if parse error. |
|
| 666 | + * @return boolean|null False if parse error. |
|
| 669 | 667 | * @access public |
| 670 | 668 | */ |
| 671 | 669 | function acceptTextToken($token, $event) { |
@@ -737,7 +735,7 @@ discard block |
||
| 737 | 735 | * @param hash $attributes Name value pairs. |
| 738 | 736 | * Attributes without content |
| 739 | 737 | * are marked as true. |
| 740 | - * @return boolean False on parse error. |
|
| 738 | + * @return boolean|null False on parse error. |
|
| 741 | 739 | * @access public |
| 742 | 740 | */ |
| 743 | 741 | function startElement($name, $attributes) { |
@@ -746,7 +744,7 @@ discard block |
||
| 746 | 744 | /** |
| 747 | 745 | * End of element event. |
| 748 | 746 | * @param string $name Element name. |
| 749 | - * @return boolean False on parse error. |
|
| 747 | + * @return boolean|null False on parse error. |
|
| 750 | 748 | * @access public |
| 751 | 749 | */ |
| 752 | 750 | function endElement($name) { |
@@ -755,7 +753,7 @@ discard block |
||
| 755 | 753 | /** |
| 756 | 754 | * Unparsed, but relevant data. |
| 757 | 755 | * @param string $text May include unparsed tags. |
| 758 | - * @return boolean False on parse error. |
|
| 756 | + * @return boolean|null False on parse error. |
|
| 759 | 757 | * @access public |
| 760 | 758 | */ |
| 761 | 759 | function addContent($text) { |
@@ -112,6 +112,7 @@ discard block |
||
| 112 | 112 | /** |
| 113 | 113 | * Sets an attribute. |
| 114 | 114 | * @param string $label Attribute name. |
| 115 | + * @param string $value |
|
| 115 | 116 | * @return string $value New attribute value. |
| 116 | 117 | * @access protected |
| 117 | 118 | */ |
@@ -1300,6 +1301,7 @@ discard block |
||
| 1300 | 1301 | /** |
| 1301 | 1302 | * Tests to see if a value is allowed. |
| 1302 | 1303 | * @param string Attempted value. |
| 1304 | + * @param string $value |
|
| 1303 | 1305 | * @return boolean True if a valid value. |
| 1304 | 1306 | * @access private |
| 1305 | 1307 | */ |
@@ -178,7 +178,7 @@ discard block |
||
| 178 | 178 | /** |
| 179 | 179 | * Breaks the request down into an object. |
| 180 | 180 | * @param string $raw Raw request. |
| 181 | - * @return SimpleFormEncoding Parsed data. |
|
| 181 | + * @return SimpleGetEncoding Parsed data. |
|
| 182 | 182 | * @access private |
| 183 | 183 | */ |
| 184 | 184 | function _parseRequest($raw) { |
@@ -266,7 +266,7 @@ discard block |
||
| 266 | 266 | /** |
| 267 | 267 | * Accessor for page if any. This may be a |
| 268 | 268 | * directory name if ambiguious. |
| 269 | - * @return Page name. |
|
| 269 | + * @return false|string name. |
|
| 270 | 270 | * @access public |
| 271 | 271 | */ |
| 272 | 272 | function getPage() { |
@@ -469,6 +469,7 @@ discard block |
||
| 469 | 469 | * @param string/SimpleUrl $base Base URL. |
| 470 | 470 | * @param string Absolute path. |
| 471 | 471 | * @access private |
| 472 | + * @return string |
|
| 472 | 473 | */ |
| 473 | 474 | function _extractAbsolutePath($base) { |
| 474 | 475 | if ($this->getHost()) { |