@@ -1359,6 +1359,8 @@ discard block |
||
1359 | 1359 | * Provide standard buttons for the forms to make it easy. Also provide |
1360 | 1360 | * a hidden op operator because the forms plugin doesn't seem to properly |
1361 | 1361 | * provide which button was clicked. |
1362 | + * @param string $form_id |
|
1363 | + * @param string $submit |
|
1362 | 1364 | */ |
1363 | 1365 | function views_ui_standard_form_buttons(&$form, &$form_state, $form_id, $name = NULL, $third = NULL, $submit = NULL) { |
1364 | 1366 | $form['buttons'] = array( |
@@ -1572,6 +1574,8 @@ discard block |
||
1572 | 1574 | /** |
1573 | 1575 | * Add another form to the stack; clicking 'update' will go to this form |
1574 | 1576 | * rather than closing the ajax pad. |
1577 | + * @param string $key |
|
1578 | + * @param string[] $args |
|
1575 | 1579 | */ |
1576 | 1580 | function views_ui_add_form_to_stack($key, &$view, $display_id, $args, $top = FALSE) { |
1577 | 1581 | if (empty($view->stack)) { |
@@ -3150,9 +3154,9 @@ discard block |
||
3150 | 3154 | /** |
3151 | 3155 | * Fetch a list of all base tables available |
3152 | 3156 | * |
3153 | - * @param $type |
|
3157 | + * @param string $type |
|
3154 | 3158 | * Either 'display', 'style' or 'row' |
3155 | - * @param $key |
|
3159 | + * @param string $key |
|
3156 | 3160 | * For style plugins, this is an optional type to restrict to. May be 'normal', |
3157 | 3161 | * 'summary', 'feed' or others based on the neds of the display. |
3158 | 3162 | * @param $base |
@@ -88,6 +88,7 @@ discard block |
||
88 | 88 | |
89 | 89 | /** |
90 | 90 | * Add text to the 'extra' region of the tabset. |
91 | + * @param string $text |
|
91 | 92 | */ |
92 | 93 | function add_extra($text) { |
93 | 94 | $this->extra .= $text; |
@@ -145,6 +146,8 @@ discard block |
||
145 | 146 | |
146 | 147 | /** |
147 | 148 | * Construct a new tab. |
149 | + * @param string $title |
|
150 | + * @param string $body |
|
148 | 151 | */ |
149 | 152 | function views_tab($name, $title, $body = NULL) { |
150 | 153 | $this->name = $name; |
@@ -409,7 +409,7 @@ discard block |
||
409 | 409 | /** |
410 | 410 | * Attach all of the handlers for each type. |
411 | 411 | * |
412 | - * @param $key |
|
412 | + * @param string $key |
|
413 | 413 | * One of 'argument', 'field', 'sort', 'filter', 'relationship' |
414 | 414 | * @param $info |
415 | 415 | * The $info from views_object_types for this object. |
@@ -715,6 +715,7 @@ discard block |
||
715 | 715 | |
716 | 716 | /** |
717 | 717 | * Internal method to build an individual set of handlers. |
718 | + * @param string $key |
|
718 | 719 | */ |
719 | 720 | function _build($key) { |
720 | 721 | $handlers = &$this->$key; |
@@ -1214,6 +1215,7 @@ discard block |
||
1214 | 1215 | |
1215 | 1216 | /** |
1216 | 1217 | * Get the base path used for this view. |
1218 | + * @return string |
|
1217 | 1219 | */ |
1218 | 1220 | function get_path() { |
1219 | 1221 | if (!empty($this->override_path)) { |
@@ -1467,6 +1469,7 @@ discard block |
||
1467 | 1469 | /** |
1468 | 1470 | * Save a row to the database for the given key, which is one of the |
1469 | 1471 | * keys from view::db_objects() |
1472 | + * @param string $key |
|
1470 | 1473 | */ |
1471 | 1474 | function _save_rows($key) { |
1472 | 1475 | $count = 0; |
@@ -1719,7 +1722,7 @@ discard block |
||
1719 | 1722 | /** |
1720 | 1723 | * Write the row to the database. |
1721 | 1724 | * |
1722 | - * @param $update |
|
1725 | + * @param string|false $update |
|
1723 | 1726 | * If true this will be an UPDATE query. Otherwise it will be an INSERT. |
1724 | 1727 | */ |
1725 | 1728 | function save_row($update = NULL) { |
@@ -1802,7 +1805,7 @@ discard block |
||
1802 | 1805 | /** |
1803 | 1806 | * Export a loaded row, such as an argument, field or the view itself to PHP code. |
1804 | 1807 | * |
1805 | - * @param $identifier |
|
1808 | + * @param string $identifier |
|
1806 | 1809 | * The variable to assign the PHP code for this object to. |
1807 | 1810 | * @param $indent |
1808 | 1811 | * An optional indentation for prettifying nested code. |
@@ -1888,7 +1891,7 @@ discard block |
||
1888 | 1891 | /** |
1889 | 1892 | * Generate a display id of a certain plugin type. |
1890 | 1893 | * |
1891 | - * @param $type |
|
1894 | + * @param string $type |
|
1892 | 1895 | * Which plugin should be used for the new display id. |
1893 | 1896 | */ |
1894 | 1897 | function generate_display_id($type) { |
@@ -1914,9 +1917,9 @@ discard block |
||
1914 | 1917 | * Create a new display and a display handler for it. |
1915 | 1918 | * @param $type |
1916 | 1919 | * The plugin type from the views plugin data. Defaults to 'page'. |
1917 | - * @param $title |
|
1920 | + * @param string $title |
|
1918 | 1921 | * The title of the display; optional, may be filled in from default. |
1919 | - * @param $id |
|
1922 | + * @param string $id |
|
1920 | 1923 | * The id to use. |
1921 | 1924 | * @return |
1922 | 1925 | * A reference to the new handler object. |
@@ -1948,6 +1951,9 @@ discard block |
||
1948 | 1951 | * Add an item with a handler to the view. |
1949 | 1952 | * |
1950 | 1953 | * These items may be fields, filters, sort criteria, or arguments. |
1954 | + * @param string $type |
|
1955 | + * @param string $table |
|
1956 | + * @param string $field |
|
1951 | 1957 | */ |
1952 | 1958 | function add_item($display_id, $type, $table, $field, $options = array(), $id = NULL) { |
1953 | 1959 | $types = views_object_types(); |
@@ -1979,6 +1985,7 @@ discard block |
||
1979 | 1985 | |
1980 | 1986 | /** |
1981 | 1987 | * Get an array of items for the current display. |
1988 | + * @param string $type |
|
1982 | 1989 | */ |
1983 | 1990 | function get_items($type, $display_id = NULL) { |
1984 | 1991 | $this->set_display($display_id); |
@@ -2059,6 +2066,9 @@ discard block |
||
2059 | 2066 | parent::init($init); |
2060 | 2067 | } |
2061 | 2068 | |
2069 | + /** |
|
2070 | + * @param string $type |
|
2071 | + */ |
|
2062 | 2072 | function options($type, $id, $title) { |
2063 | 2073 | $this->display_plugin = $type; |
2064 | 2074 | $this->id = $id; |
@@ -75,6 +75,9 @@ |
||
75 | 75 | } |
76 | 76 | } |
77 | 77 | |
78 | + /** |
|
79 | + * @param string $data |
|
80 | + */ |
|
78 | 81 | function render_link($data, $values) { |
79 | 82 | if (!empty($this->options['link_to_comment']) && $data !== NULL && $data !== '') { |
80 | 83 | $node = new stdClass(); |
@@ -69,7 +69,7 @@ |
||
69 | 69 | * performance hits during menu item access testing, which happens |
70 | 70 | * a lot. |
71 | 71 | * |
72 | - * @return an array; the first item should be the function to call, |
|
72 | + * @return boolean array; the first item should be the function to call, |
|
73 | 73 | * and the second item should be an array of arguments. The first |
74 | 74 | * item may also be TRUE (bool only) which will indicate no |
75 | 75 | * access control.) |
@@ -467,7 +467,7 @@ discard block |
||
467 | 467 | * current display |
468 | 468 | * |
469 | 469 | * @return |
470 | - * TRUE for the default display |
|
470 | + boolean TRUE for the default display |
|
471 | 471 | */ |
472 | 472 | function is_defaulted($option) { |
473 | 473 | return !$this->is_default_display() && !empty($this->default_display) && !empty($this->options['defaults'][$option]); |
@@ -645,6 +645,7 @@ discard block |
||
645 | 645 | /** |
646 | 646 | * Because forms may be split up into sections, this provides |
647 | 647 | * an easy URL to exactly the right section. Don't override this. |
648 | + * @param string $section |
|
648 | 649 | */ |
649 | 650 | function option_link($text, $section, $class = '', $title = '') { |
650 | 651 | if (!empty($class)) { |
@@ -1703,6 +1704,7 @@ discard block |
||
1703 | 1704 | |
1704 | 1705 | /** |
1705 | 1706 | * Flip the override setting for the given section. |
1707 | + * @param boolean $new_state |
|
1706 | 1708 | */ |
1707 | 1709 | function set_override($section, $new_state = NULL) { |
1708 | 1710 | $options = $this->defaultable_sections($section); |
@@ -1767,6 +1769,7 @@ discard block |
||
1767 | 1769 | |
1768 | 1770 | /** |
1769 | 1771 | * Render a text area, using the proper format. |
1772 | + * @param string $area |
|
1770 | 1773 | */ |
1771 | 1774 | function render_textarea($area) { |
1772 | 1775 | static $formats = array(); |
@@ -183,6 +183,7 @@ |
||
183 | 183 | /** |
184 | 184 | * Save the block cache setting in the blocks table if this block allready |
185 | 185 | * exists in the blocks table. Dirty fix untill http://drupal.org/node/235673 gets in. |
186 | + * @param string $delta |
|
186 | 187 | */ |
187 | 188 | function save_block_cache($delta, $cache_setting) { |
188 | 189 | if ($bid = db_fetch_object(db_query("SELECT bid, cache FROM {blocks} WHERE module = 'views' AND delta = '%s'", $delta))) { |
@@ -231,6 +231,7 @@ |
||
231 | 231 | * The index count of the row. |
232 | 232 | * @param $field |
233 | 233 | * The id of the field. |
234 | + * @return string |
|
234 | 235 | */ |
235 | 236 | function get_field($index, $field) { |
236 | 237 | if (!isset($this->rendered_fields)) { |
@@ -510,6 +510,7 @@ discard block |
||
510 | 510 | /** |
511 | 511 | * Set the current 'page view' that is being displayed so that it is easy |
512 | 512 | * for other modules or the theme to identify. |
513 | + * @param views_plugin_display_page $view |
|
513 | 514 | */ |
514 | 515 | function &views_set_page_view($view = NULL) { |
515 | 516 | static $cache = NULL; |
@@ -556,6 +557,7 @@ discard block |
||
556 | 557 | |
557 | 558 | /** |
558 | 559 | * Include views .inc files as necessary. |
560 | + * @param string $file |
|
559 | 561 | */ |
560 | 562 | function views_include($file) { |
561 | 563 | static $used = array(); |
@@ -568,6 +570,7 @@ discard block |
||
568 | 570 | |
569 | 571 | /** |
570 | 572 | * Load views files on behalf of modules. |
573 | + * @param string $file |
|
571 | 574 | */ |
572 | 575 | function views_module_include($file) { |
573 | 576 | foreach (views_get_module_apis() as $module => $info) { |
@@ -601,6 +604,7 @@ discard block |
||
601 | 604 | |
602 | 605 | /** |
603 | 606 | * Include views .css files. |
607 | + * @param string $file |
|
604 | 608 | */ |
605 | 609 | function views_add_css($file) { |
606 | 610 | // We set preprocess to FALSE because we are adding the files conditionally, |
@@ -612,6 +616,7 @@ discard block |
||
612 | 616 | |
613 | 617 | /** |
614 | 618 | * Include views .js files. |
619 | + * @param string $file |
|
615 | 620 | */ |
616 | 621 | function views_add_js($file) { |
617 | 622 | // If javascript has been disabled by the user, never add js files. |
@@ -722,6 +727,7 @@ discard block |
||
722 | 727 | /** |
723 | 728 | * Get a handler for a plugin |
724 | 729 | * |
730 | + * @param string $type |
|
725 | 731 | * @return views_plugin |
726 | 732 | * |
727 | 733 | * The created plugin object. |
@@ -807,6 +813,7 @@ discard block |
||
807 | 813 | * array($view, $display_id), |
808 | 814 | * ); |
809 | 815 | * @endcode |
816 | + * @param string $type |
|
810 | 817 | */ |
811 | 818 | function views_get_applicable_views($type) { |
812 | 819 | // @todo: Use a smarter flagging system so that we don't have to |