| @@ -48,6 +48,9 @@ discard block | ||
| 48 | 48 | return $str ; | 
| 49 | 49 | } | 
| 50 | 50 | |
| 51 | + /** | |
| 52 | + * @param string $id | |
| 53 | + */ | |
| 51 | 54 |  	function save($id) { | 
| 52 | 55 | return PHPBuilder::build() | 
| 53 | 56 | ->l( | 
| @@ -56,6 +59,9 @@ discard block | ||
| 56 | 59 | ); | 
| 57 | 60 | } | 
| 58 | 61 | |
| 62 | + /** | |
| 63 | + * @param string $id | |
| 64 | + */ | |
| 59 | 65 |  	function restore( $id, $remove = FALSE ) { | 
| 60 | 66 | $code = PHPBuilder::build() | 
| 61 | 67 | ->l( | 
| @@ -71,6 +77,10 @@ discard block | ||
| 71 | 77 | return $code ; | 
| 72 | 78 | } | 
| 73 | 79 | |
| 80 | + /** | |
| 81 | + * @param string $on | |
| 82 | + * @param PHPBuilder $fail | |
| 83 | + */ | |
| 74 | 84 |  	function match_fail_conditional( $on, $match = NULL, $fail = NULL ) { | 
| 75 | 85 | return PHPBuilder::build() | 
| 76 | 86 |  			->b( 'if (' . $on . ')', | 
| @@ -83,6 +93,9 @@ discard block | ||
| 83 | 93 | ); | 
| 84 | 94 | } | 
| 85 | 95 | |
| 96 | + /** | |
| 97 | + * @param PHPBuilder $code | |
| 98 | + */ | |
| 86 | 99 |  	function match_fail_block( $code ) { | 
| 87 | 100 | $id = $this->varid() ; | 
| 88 | 101 | |
| @@ -131,6 +144,9 @@ discard block | ||
| 131 | 144 | public $type ; | 
| 132 | 145 | public $value ; | 
| 133 | 146 | |
| 147 | + /** | |
| 148 | + * @param string $type | |
| 149 | + */ | |
| 134 | 150 |  	function __construct( $type, $value = NULL ) { | 
| 135 | 151 | $this->type = $type ; | 
| 136 | 152 | $this->value = $value ; | 
| @@ -269,6 +285,10 @@ discard block | ||
| 269 | 285 | } | 
| 270 | 286 | |
| 271 | 287 |  class TokenLiteral extends TokenExpressionable { | 
| 288 | + | |
| 289 | + /** | |
| 290 | + * @param string $value | |
| 291 | + */ | |
| 272 | 292 |  	function __construct( $value ) { | 
| 273 | 293 | parent::__construct( 'literal', "'" . substr($value,1,-1) . "'" ); | 
| 274 | 294 | } | 
| @@ -294,6 +314,9 @@ discard block | ||
| 294 | 314 | return $rx ; | 
| 295 | 315 | } | 
| 296 | 316 | |
| 317 | + /** | |
| 318 | + * @param string $value | |
| 319 | + */ | |
| 297 | 320 |  	function __construct( $value ) { | 
| 298 | 321 |  		parent::__construct('rx', self::escape($value)); | 
| 299 | 322 | } | 
| @@ -304,6 +327,10 @@ discard block | ||
| 304 | 327 | } | 
| 305 | 328 | |
| 306 | 329 |  class TokenWhitespace extends TokenTerminal { | 
| 330 | + | |
| 331 | + /** | |
| 332 | + * @param boolean $optional | |
| 333 | + */ | |
| 307 | 334 |  	function __construct( $optional ) { | 
| 308 | 335 | parent::__construct( 'whitespace', $optional ) ; | 
| 309 | 336 | } | 
| @@ -316,6 +343,10 @@ discard block | ||
| 316 | 343 | } | 
| 317 | 344 | |
| 318 | 345 |  class TokenRecurse extends Token { | 
| 346 | + | |
| 347 | + /** | |
| 348 | + * @param string $value | |
| 349 | + */ | |
| 319 | 350 |  	function __construct( $value ) { | 
| 320 | 351 | parent::__construct( 'recurse', $value ) ; | 
| 321 | 352 | } | 
| @@ -438,6 +469,9 @@ discard block | ||
| 438 | 469 | $this->what = NULL ; | 
| 439 | 470 | } | 
| 440 | 471 | |
| 472 | + /** | |
| 473 | + * @param string $what | |
| 474 | + */ | |
| 441 | 475 |  	function set( $what, $val = TRUE ) { | 
| 442 | 476 | $this->what = $what ; | 
| 443 | 477 | $this->val = $val ; | 
| @@ -498,6 +532,9 @@ discard block | ||
| 498 | 532 | public $mode; | 
| 499 | 533 | public $rule; | 
| 500 | 534 | |
| 535 | + /** | |
| 536 | + * @param RuleSet $parser | |
| 537 | + */ | |
| 501 | 538 |  	function __construct($parser, $lines) { | 
| 502 | 539 | $this->parser = $parser; | 
| 503 | 540 | $this->lines = $lines; | 
| @@ -595,6 +632,9 @@ discard block | ||
| 595 | 632 | [^/] # Anything except / | 
| 596 | 633 | )*/}xu' ; | 
| 597 | 634 | |
| 635 | + /** | |
| 636 | + * @param string $str | |
| 637 | + */ | |
| 598 | 638 |  	function tokenize( $str, &$tokens, $o = 0 ) { | 
| 599 | 639 | |
| 600 | 640 | $pending = new Pending() ; | 
| @@ -848,6 +888,9 @@ discard block | ||
| 848 | 888 | return self::$parsers[$class]->compile($indent, $match[3]); | 
| 849 | 889 | } | 
| 850 | 890 | |
| 891 | + /** | |
| 892 | + * @param string $string | |
| 893 | + */ | |
| 851 | 894 |  	static function compile( $string ) { | 
| 852 | 895 | static $rx = '@ | 
| 853 | 896 | ^([\x20\t]*)/\*!\* (?:[\x20\t]*(!?\w*))? # Start with some indent, a comment with the special marker, then an optional name | 
| @@ -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() { | 
| @@ -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()) { |