@@ -430,6 +430,7 @@ |
||
430 | 430 | * The arguments should exactly match drupal_add_css(). |
431 | 431 | * |
432 | 432 | * @see drupal_add_css |
433 | + * @param string $filename |
|
433 | 434 | */ |
434 | 435 | function add_css($filename, $type = 'module', $media = 'all', $preprocess = TRUE) { |
435 | 436 | $path = file_create_path($filename); |
@@ -270,6 +270,7 @@ discard block |
||
270 | 270 | * to function allowing us to render our CSS and HTML easily. |
271 | 271 | * |
272 | 272 | * @todo Convert the functions to methods and make this properly OO. |
273 | + * @param boolean $admin |
|
273 | 274 | */ |
274 | 275 | function panels_flexible_create_renderer($admin, $id, $content, $settings, &$display, $layout, $handler) { |
275 | 276 | $renderer = new stdClass; |
@@ -435,6 +436,7 @@ discard block |
||
435 | 436 | |
436 | 437 | /** |
437 | 438 | * Render a piece of a flexible layout. |
439 | + * @param stdClass $renderer |
|
438 | 440 | */ |
439 | 441 | function panels_flexible_render_items($renderer, $list, $owner_id) { |
440 | 442 | $output = ''; |
@@ -493,6 +495,7 @@ discard block |
||
493 | 495 | |
494 | 496 | /** |
495 | 497 | * Render a column in the flexible layout. |
498 | + * @param integer $max |
|
496 | 499 | */ |
497 | 500 | function panels_flexible_render_item($renderer, $item, $content, $id, $position, $max, $clear = FALSE) { |
498 | 501 | |
@@ -707,6 +710,7 @@ discard block |
||
707 | 710 | } |
708 | 711 | /** |
709 | 712 | * Provide CSS for a flexible layout. |
713 | + * @param stdClass $renderer |
|
710 | 714 | */ |
711 | 715 | function panels_flexible_render_css($renderer) { |
712 | 716 | if ($renderer->admin) { |
@@ -724,6 +728,9 @@ discard block |
||
724 | 728 | * Columns and regions, when displayed as a group, need to cooperate in |
725 | 729 | * order to share margins and make sure that percent widths add up |
726 | 730 | * to the right total. |
731 | + * @param string $owner_id |
|
732 | + * @param string $type |
|
733 | + * @param string $id |
|
727 | 734 | */ |
728 | 735 | function panels_flexible_render_css_group($renderer, $list, $owner_id, $type, $id) { |
729 | 736 | $css = array(); |
@@ -202,6 +202,11 @@ |
||
202 | 202 | return $value; |
203 | 203 | } |
204 | 204 | |
205 | + /** |
|
206 | + * @param string $option |
|
207 | + * |
|
208 | + * @return string |
|
209 | + */ |
|
205 | 210 | function case_transform($string, $option) { |
206 | 211 | global $multibyte; |
207 | 212 |
@@ -566,6 +566,7 @@ |
||
566 | 566 | |
567 | 567 | /** |
568 | 568 | * Trim the field down to the specified length. |
569 | + * @param string $value |
|
569 | 570 | */ |
570 | 571 | function render_trim_text($alter, $value) { |
571 | 572 | if (!empty($alter['strip_tags'])) { |
@@ -453,6 +453,7 @@ |
||
453 | 453 | /** |
454 | 454 | * Make some translations to a form item to make it more suitable to |
455 | 455 | * exposing. |
456 | + * @param string $type |
|
456 | 457 | */ |
457 | 458 | function exposed_translate(&$form, $type) { |
458 | 459 | if (!isset($form['#type'])) { |
@@ -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(); |