@@ -123,6 +123,9 @@ discard block |
||
123 | 123 | return new Polygon($components); |
124 | 124 | } |
125 | 125 | |
126 | + /** |
|
127 | + * @param string $type |
|
128 | + */ |
|
126 | 129 | function getMulti(&$mem, $type) { |
127 | 130 | // Get the number of items expected in this multi out of the first 4 bytes |
128 | 131 | $multi_length = unpack('L',fread($mem,4)); |
@@ -196,6 +199,9 @@ discard block |
||
196 | 199 | } |
197 | 200 | } |
198 | 201 | |
202 | + /** |
|
203 | + * @param Geometry $point |
|
204 | + */ |
|
199 | 205 | function writePoint($point) { |
200 | 206 | // Set the coords |
201 | 207 | $wkb = pack('dd',$point->x(), $point->y()); |
@@ -215,6 +221,9 @@ discard block |
||
215 | 221 | return $wkb; |
216 | 222 | } |
217 | 223 | |
224 | + /** |
|
225 | + * @param Geometry $poly |
|
226 | + */ |
|
218 | 227 | function writePolygon($poly) { |
219 | 228 | // Set the number of lines in this poly |
220 | 229 | $wkb = pack('L',$poly->numGeometries()); |
@@ -227,6 +236,9 @@ discard block |
||
227 | 236 | return $wkb; |
228 | 237 | } |
229 | 238 | |
239 | + /** |
|
240 | + * @param Geometry $geometry |
|
241 | + */ |
|
230 | 242 | function writeMulti($geometry) { |
231 | 243 | // Set the number of components |
232 | 244 | $wkb = pack('L',$geometry->numGeometries()); |
@@ -8,7 +8,6 @@ discard block |
||
8 | 8 | /** |
9 | 9 | * Read WKT string into geometry objects |
10 | 10 | * |
11 | - * @param string $WKT A WKT string |
|
12 | 11 | * |
13 | 12 | * @return Geometry |
14 | 13 | */ |
@@ -184,11 +183,17 @@ discard block |
||
184 | 183 | else return $str; |
185 | 184 | } |
186 | 185 | |
186 | + /** |
|
187 | + * @param string $char |
|
188 | + */ |
|
187 | 189 | protected function beginsWith($str, $char) { |
188 | 190 | if (substr($str,0,strlen($char)) == $char) return TRUE; |
189 | 191 | else return FALSE; |
190 | 192 | } |
191 | 193 | |
194 | + /** |
|
195 | + * @param string $char |
|
196 | + */ |
|
192 | 197 | protected function endsWith($str, $char) { |
193 | 198 | if (substr($str,(0 - strlen($char))) == $char) return TRUE; |
194 | 199 | else return FALSE; |
@@ -193,6 +193,9 @@ |
||
193 | 193 | } |
194 | 194 | } |
195 | 195 | |
196 | + /** |
|
197 | + * @param Point $point |
|
198 | + */ |
|
196 | 199 | public function pointOnVertex($point) { |
197 | 200 | foreach($this->getPoints() as $vertex) { |
198 | 201 | if ($point->equals($vertex)) { |
@@ -41,6 +41,10 @@ |
||
41 | 41 | print "Testing Done!"; |
42 | 42 | } |
43 | 43 | |
44 | +/** |
|
45 | + * @param resource $connection |
|
46 | + * @param string $format |
|
47 | + */ |
|
44 | 48 | function test_postgis($name, $type, $geom, $connection, $format) { |
45 | 49 | global $table; |
46 | 50 |
@@ -112,6 +112,9 @@ discard block |
||
112 | 112 | $geometry->m(); |
113 | 113 | } |
114 | 114 | |
115 | +/** |
|
116 | + * @param string $input |
|
117 | + */ |
|
115 | 118 | function test_adapters($geometry, $format, $input) { |
116 | 119 | // Test adapter output and input. Do a round-trip and re-test |
117 | 120 | foreach (geoPHP::getAdapterMap() as $adapter_key => $adapter_class) { |
@@ -234,6 +237,9 @@ discard block |
||
234 | 237 | } |
235 | 238 | } |
236 | 239 | |
240 | +/** |
|
241 | + * @param string $value |
|
242 | + */ |
|
237 | 243 | function test_detection($value, $format, $file) { |
238 | 244 | $detected = geoPHP::detectFormat($value); |
239 | 245 | if ($detected != $format) { |
@@ -58,6 +58,10 @@ |
||
58 | 58 | } |
59 | 59 | } |
60 | 60 | |
61 | + /** |
|
62 | + * @param string $method_name |
|
63 | + * @param string|null $argument |
|
64 | + */ |
|
61 | 65 | function _methods_tester($geometry, $method_name, $argument) { |
62 | 66 | |
63 | 67 | if (!method_exists($geometry, $method_name)) { |
@@ -68,6 +68,9 @@ discard block |
||
68 | 68 | // ----------------------------------------------------------------------------- |
69 | 69 | // get html dom from file |
70 | 70 | // $maxlen is defined in the code as PHP_STREAM_COPY_ALL which is defined as -1. |
71 | +/** |
|
72 | + * @param string $url |
|
73 | + */ |
|
71 | 74 | function file_get_html($url, $use_include_path = false, $context=null, $offset = -1, $maxLen=-1, $lowercase = true, $forceTagsClosed=true, $target_charset = DEFAULT_TARGET_CHARSET, $stripRN=true, $defaultBRText=DEFAULT_BR_TEXT, $defaultSpanText=DEFAULT_SPAN_TEXT) |
72 | 75 | { |
73 | 76 | // We DO force the tags to be terminated. |
@@ -125,6 +128,9 @@ discard block |
||
125 | 128 | public $tag_start = 0; |
126 | 129 | private $dom = null; |
127 | 130 | |
131 | + /** |
|
132 | + * @param simple_html_dom $dom |
|
133 | + */ |
|
128 | 134 | function __construct($dom) |
129 | 135 | { |
130 | 136 | $this->dom = $dom; |
@@ -1501,6 +1507,11 @@ discard block |
||
1501 | 1507 | } |
1502 | 1508 | |
1503 | 1509 | // parse attributes |
1510 | + |
|
1511 | + /** |
|
1512 | + * @param simple_html_dom_node $node |
|
1513 | + * @param string[] $space |
|
1514 | + */ |
|
1504 | 1515 | protected function parse_attr($node, $name, &$space) |
1505 | 1516 | { |
1506 | 1517 | // Per sourceforge: http://sourceforge.net/tracker/?func=detail&aid=3061408&group_id=218559&atid=1044037 |
@@ -1538,6 +1549,11 @@ discard block |
||
1538 | 1549 | } |
1539 | 1550 | |
1540 | 1551 | // link node's parent |
1552 | + |
|
1553 | + /** |
|
1554 | + * @param simple_html_dom_node $node |
|
1555 | + * @param boolean $is_child |
|
1556 | + */ |
|
1541 | 1557 | protected function link_nodes(&$node, $is_child) |
1542 | 1558 | { |
1543 | 1559 | $node->parent = $this->parent; |
@@ -1549,6 +1565,10 @@ discard block |
||
1549 | 1565 | } |
1550 | 1566 | |
1551 | 1567 | // as a text node |
1568 | + |
|
1569 | + /** |
|
1570 | + * @param string $tag |
|
1571 | + */ |
|
1552 | 1572 | protected function as_text_node($tag) |
1553 | 1573 | { |
1554 | 1574 | $node = new simple_html_dom_node($this); |
@@ -1559,12 +1579,18 @@ discard block |
||
1559 | 1579 | return true; |
1560 | 1580 | } |
1561 | 1581 | |
1582 | + /** |
|
1583 | + * @param string $chars |
|
1584 | + */ |
|
1562 | 1585 | protected function skip($chars) |
1563 | 1586 | { |
1564 | 1587 | $this->pos += strspn($this->doc, $chars, $this->pos); |
1565 | 1588 | $this->char = ($this->pos<$this->size) ? $this->doc[$this->pos] : null; // next |
1566 | 1589 | } |
1567 | 1590 | |
1591 | + /** |
|
1592 | + * @param string $chars |
|
1593 | + */ |
|
1568 | 1594 | protected function copy_skip($chars) |
1569 | 1595 | { |
1570 | 1596 | $pos = $this->pos; |
@@ -1575,6 +1601,9 @@ discard block |
||
1575 | 1601 | return substr($this->doc, $pos, $len); |
1576 | 1602 | } |
1577 | 1603 | |
1604 | + /** |
|
1605 | + * @param string $chars |
|
1606 | + */ |
|
1578 | 1607 | protected function copy_until($chars) |
1579 | 1608 | { |
1580 | 1609 | $pos = $this->pos; |
@@ -1584,6 +1613,9 @@ discard block |
||
1584 | 1613 | return substr($this->doc, $pos, $len); |
1585 | 1614 | } |
1586 | 1615 | |
1616 | + /** |
|
1617 | + * @param string $char |
|
1618 | + */ |
|
1587 | 1619 | protected function copy_until_char($char) |
1588 | 1620 | { |
1589 | 1621 | if ($this->char===null) return ''; |
@@ -1602,6 +1634,9 @@ discard block |
||
1602 | 1634 | return substr($this->doc, $pos_old, $pos-$pos_old); |
1603 | 1635 | } |
1604 | 1636 | |
1637 | + /** |
|
1638 | + * @param string $char |
|
1639 | + */ |
|
1605 | 1640 | protected function copy_until_char_escape($char) |
1606 | 1641 | { |
1607 | 1642 | if ($this->char===null) return ''; |
@@ -1633,6 +1668,10 @@ discard block |
||
1633 | 1668 | |
1634 | 1669 | // remove noise from html content |
1635 | 1670 | // save the noise in the $this->noise array. |
1671 | + |
|
1672 | + /** |
|
1673 | + * @param string $pattern |
|
1674 | + */ |
|
1636 | 1675 | protected function remove_noise($pattern, $remove_tag=false) |
1637 | 1676 | { |
1638 | 1677 | global $debug_object; |
@@ -1658,6 +1697,10 @@ discard block |
||
1658 | 1697 | } |
1659 | 1698 | |
1660 | 1699 | // restore noise to html content |
1700 | + |
|
1701 | + /** |
|
1702 | + * @param string|null $text |
|
1703 | + */ |
|
1661 | 1704 | function restore_noise($text) |
1662 | 1705 | { |
1663 | 1706 | global $debug_object; |
@@ -122,6 +122,9 @@ |
||
122 | 122 | return self::array_random( empty( $lang ) ? self::$languages : $lang ); |
123 | 123 | } |
124 | 124 | |
125 | + /** |
|
126 | + * @param string $os |
|
127 | + */ |
|
125 | 128 | private static function get_processor( $os ) |
126 | 129 | { |
127 | 130 | return self::array_random( self::$processors[$os] ); |
@@ -68,6 +68,9 @@ discard block |
||
68 | 68 | // ----------------------------------------------------------------------------- |
69 | 69 | // get html dom from file |
70 | 70 | // $maxlen is defined in the code as PHP_STREAM_COPY_ALL which is defined as -1. |
71 | +/** |
|
72 | + * @param string $url |
|
73 | + */ |
|
71 | 74 | function file_get_html($url, $use_include_path = false, $context=null, $offset = -1, $maxLen=-1, $lowercase = true, $forceTagsClosed=true, $target_charset = DEFAULT_TARGET_CHARSET, $stripRN=true, $defaultBRText=DEFAULT_BR_TEXT, $defaultSpanText=DEFAULT_SPAN_TEXT) |
72 | 75 | { |
73 | 76 | // We DO force the tags to be terminated. |
@@ -125,6 +128,9 @@ discard block |
||
125 | 128 | public $tag_start = 0; |
126 | 129 | private $dom = null; |
127 | 130 | |
131 | + /** |
|
132 | + * @param simple_html_dom $dom |
|
133 | + */ |
|
128 | 134 | function __construct($dom) |
129 | 135 | { |
130 | 136 | $this->dom = $dom; |
@@ -1501,6 +1507,11 @@ discard block |
||
1501 | 1507 | } |
1502 | 1508 | |
1503 | 1509 | // parse attributes |
1510 | + |
|
1511 | + /** |
|
1512 | + * @param simple_html_dom_node $node |
|
1513 | + * @param string[] $space |
|
1514 | + */ |
|
1504 | 1515 | protected function parse_attr($node, $name, &$space) |
1505 | 1516 | { |
1506 | 1517 | // Per sourceforge: http://sourceforge.net/tracker/?func=detail&aid=3061408&group_id=218559&atid=1044037 |
@@ -1538,6 +1549,11 @@ discard block |
||
1538 | 1549 | } |
1539 | 1550 | |
1540 | 1551 | // link node's parent |
1552 | + |
|
1553 | + /** |
|
1554 | + * @param simple_html_dom_node $node |
|
1555 | + * @param boolean $is_child |
|
1556 | + */ |
|
1541 | 1557 | protected function link_nodes(&$node, $is_child) |
1542 | 1558 | { |
1543 | 1559 | $node->parent = $this->parent; |
@@ -1549,6 +1565,10 @@ discard block |
||
1549 | 1565 | } |
1550 | 1566 | |
1551 | 1567 | // as a text node |
1568 | + |
|
1569 | + /** |
|
1570 | + * @param string $tag |
|
1571 | + */ |
|
1552 | 1572 | protected function as_text_node($tag) |
1553 | 1573 | { |
1554 | 1574 | $node = new simple_html_dom_node($this); |
@@ -1559,12 +1579,18 @@ discard block |
||
1559 | 1579 | return true; |
1560 | 1580 | } |
1561 | 1581 | |
1582 | + /** |
|
1583 | + * @param string $chars |
|
1584 | + */ |
|
1562 | 1585 | protected function skip($chars) |
1563 | 1586 | { |
1564 | 1587 | $this->pos += strspn($this->doc, $chars, $this->pos); |
1565 | 1588 | $this->char = ($this->pos<$this->size) ? $this->doc[$this->pos] : null; // next |
1566 | 1589 | } |
1567 | 1590 | |
1591 | + /** |
|
1592 | + * @param string $chars |
|
1593 | + */ |
|
1568 | 1594 | protected function copy_skip($chars) |
1569 | 1595 | { |
1570 | 1596 | $pos = $this->pos; |
@@ -1575,6 +1601,9 @@ discard block |
||
1575 | 1601 | return substr($this->doc, $pos, $len); |
1576 | 1602 | } |
1577 | 1603 | |
1604 | + /** |
|
1605 | + * @param string $chars |
|
1606 | + */ |
|
1578 | 1607 | protected function copy_until($chars) |
1579 | 1608 | { |
1580 | 1609 | $pos = $this->pos; |
@@ -1584,6 +1613,9 @@ discard block |
||
1584 | 1613 | return substr($this->doc, $pos, $len); |
1585 | 1614 | } |
1586 | 1615 | |
1616 | + /** |
|
1617 | + * @param string $char |
|
1618 | + */ |
|
1587 | 1619 | protected function copy_until_char($char) |
1588 | 1620 | { |
1589 | 1621 | if ($this->char===null) return ''; |
@@ -1602,6 +1634,9 @@ discard block |
||
1602 | 1634 | return substr($this->doc, $pos_old, $pos-$pos_old); |
1603 | 1635 | } |
1604 | 1636 | |
1637 | + /** |
|
1638 | + * @param string $char |
|
1639 | + */ |
|
1605 | 1640 | protected function copy_until_char_escape($char) |
1606 | 1641 | { |
1607 | 1642 | if ($this->char===null) return ''; |
@@ -1633,6 +1668,10 @@ discard block |
||
1633 | 1668 | |
1634 | 1669 | // remove noise from html content |
1635 | 1670 | // save the noise in the $this->noise array. |
1671 | + |
|
1672 | + /** |
|
1673 | + * @param string $pattern |
|
1674 | + */ |
|
1636 | 1675 | protected function remove_noise($pattern, $remove_tag=false) |
1637 | 1676 | { |
1638 | 1677 | global $debug_object; |
@@ -1658,6 +1697,10 @@ discard block |
||
1658 | 1697 | } |
1659 | 1698 | |
1660 | 1699 | // restore noise to html content |
1700 | + |
|
1701 | + /** |
|
1702 | + * @param string|null $text |
|
1703 | + */ |
|
1661 | 1704 | function restore_noise($text) |
1662 | 1705 | { |
1663 | 1706 | global $debug_object; |