@@ -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 |
@@ -1234,6 +1234,8 @@ discard block |
||
1234 | 1234 | * |
1235 | 1235 | * For each operation, both this function and _content_field_invoke_default() are |
1236 | 1236 | * called so that the default database handling can occur. |
1237 | + * @param string $op |
|
1238 | + * @param boolean $page |
|
1237 | 1239 | */ |
1238 | 1240 | function _content_field_invoke($op, &$node, $teaser = NULL, $page = NULL) { |
1239 | 1241 | $type_name = is_string($node) ? $node : (is_array($node) ? $node['type'] : $node->type); |
@@ -1268,6 +1270,8 @@ discard block |
||
1268 | 1270 | |
1269 | 1271 | /** |
1270 | 1272 | * Invoke content.module's version of a field hook. |
1273 | + * @param string $op |
|
1274 | + * @param boolean $page |
|
1271 | 1275 | */ |
1272 | 1276 | function _content_field_invoke_default($op, &$node, $teaser = NULL, $page = NULL) { |
1273 | 1277 | $type_name = is_string($node) ? $node : (is_array($node) ? $node['type'] : $node->type); |
@@ -1746,6 +1750,7 @@ discard block |
||
1746 | 1750 | * Used for items entered by administrators, like field descriptions, |
1747 | 1751 | * allowed values, where some (mainly inline) mark-up may be desired |
1748 | 1752 | * (so check_plain() is not acceptable). |
1753 | + * @return string |
|
1749 | 1754 | */ |
1750 | 1755 | function content_filter_xss($string) { |
1751 | 1756 | return filter_xss($string, _content_filter_xss_allowed_tags()); |
@@ -1975,7 +1980,7 @@ discard block |
||
1975 | 1980 | * |
1976 | 1981 | * @param $name |
1977 | 1982 | * The name of the content type or content field |
1978 | - * @param $storage |
|
1983 | + * @param integer $storage |
|
1979 | 1984 | * CONTENT_DB_STORAGE_PER_FIELD or CONTENT_DB_STORAGE_PER_CONTENT_TYPE |
1980 | 1985 | * @return |
1981 | 1986 | * A string containing the generated name for the database table |
@@ -2109,7 +2114,7 @@ discard block |
||
2109 | 2114 | * @param $name |
2110 | 2115 | * Name of the index. |
2111 | 2116 | * @return |
2112 | - * TRUE if the table exists. Otherwise FALSE. |
|
2117 | + boolean TRUE if the table exists. Otherwise FALSE. |
|
2113 | 2118 | */ |
2114 | 2119 | function content_db_index_exists($table, $name) { |
2115 | 2120 | global $db_type; |
@@ -2139,9 +2144,9 @@ discard block |
||
2139 | 2144 | * with respect to a given operation. (currently used for field 'view', |
2140 | 2145 | * and widget 'default values' and 'multiple values') |
2141 | 2146 | * |
2142 | - * @param $entity |
|
2147 | + * @param string $entity |
|
2143 | 2148 | * 'field' or 'widget' |
2144 | - * @param $op |
|
2149 | + * @param string $op |
|
2145 | 2150 | * the name of the operation ('view', 'default value'...) |
2146 | 2151 | * @param $field |
2147 | 2152 | * The field array, including widget info. |
@@ -2169,9 +2174,9 @@ discard block |
||
2169 | 2174 | * |
2170 | 2175 | * Currently used for widgets and formatters 'multiple values'. |
2171 | 2176 | * |
2172 | - * @param $entity |
|
2177 | + * @param string $entity |
|
2173 | 2178 | * 'field', 'widget' or 'formatter' |
2174 | - * @param $op |
|
2179 | + * @param string $op |
|
2175 | 2180 | * the name of the operation ('default values'...) |
2176 | 2181 | * @param $object |
2177 | 2182 | * - if $entity is 'field' or 'widget': the field array, |
@@ -2232,7 +2237,7 @@ discard block |
||
2232 | 2237 | /** |
2233 | 2238 | * Determine whether the user has access to a given field. |
2234 | 2239 | * |
2235 | - * @param $op |
|
2240 | + * @param string $op |
|
2236 | 2241 | * The operation to be performed. Possible values: |
2237 | 2242 | * - "edit" |
2238 | 2243 | * - "view" |
@@ -2243,7 +2248,7 @@ discard block |
||
2243 | 2248 | * @param $node |
2244 | 2249 | * (optional) The node on which the operation is to be performed. |
2245 | 2250 | * @return |
2246 | - * TRUE if the operation is allowed; |
|
2251 | + boolean TRUE if the operation is allowed; |
|
2247 | 2252 | * FALSE if the operation is denied. |
2248 | 2253 | */ |
2249 | 2254 | function content_access($op, $field, $account = NULL, $node = NULL) { |
@@ -2324,7 +2329,7 @@ discard block |
||
2324 | 2329 | * hook_content_build_modes(). |
2325 | 2330 | * |
2326 | 2331 | * @return |
2327 | - * Whether or not content is to be added to $content in this context. |
|
2332 | + boolean Whether or not content is to be added to $content in this context. |
|
2328 | 2333 | * Uses the value of the 'Exclude' checkbox for this field |
2329 | 2334 | * as set on the Manage fields screen. |
2330 | 2335 | */ |
@@ -2572,7 +2577,7 @@ discard block |
||
2572 | 2577 | * |
2573 | 2578 | * @param $type_name |
2574 | 2579 | * The content type name. |
2575 | - * @param $pseudo_field_name |
|
2580 | + * @param string $pseudo_field_name |
|
2576 | 2581 | * The name of the 'field'. |
2577 | 2582 | * @return |
2578 | 2583 | * The weight for the 'field', respecting the user settings stored |
@@ -430,7 +430,7 @@ discard block |
||
430 | 430 | * Optional. The user object. If none given, the current user will be used. |
431 | 431 | * |
432 | 432 | * @return |
433 | - * Boolean TRUE if the user is allowed to flag/unflag. FALSE otherwise. |
|
433 | + boolean Boolean TRUE if the user is allowed to flag/unflag. FALSE otherwise. |
|
434 | 434 | */ |
435 | 435 | function user_access($action = 'flag', $account = NULL) { |
436 | 436 | if (!isset($account)) { |
@@ -620,7 +620,7 @@ discard block |
||
620 | 620 | * @param $skip_permission_check |
621 | 621 | * Flag the item even if the $account user don't have permission to do so. |
622 | 622 | * @return |
623 | - * FALSE if some error occured (e.g., user has no permission, flag isn't |
|
623 | + boolean FALSE if some error occured (e.g., user has no permission, flag isn't |
|
624 | 624 | * applicable to the item, etc.), TRUE otherwise. |
625 | 625 | */ |
626 | 626 | function flag($action, $content_id, $account = NULL, $skip_permission_check = FALSE) { |
@@ -702,7 +702,7 @@ discard block |
||
702 | 702 | * current user will be used. |
703 | 703 | * |
704 | 704 | * @return |
705 | - * TRUE if the content is flagged, FALSE otherwise. |
|
705 | + boolean TRUE if the content is flagged, FALSE otherwise. |
|
706 | 706 | */ |
707 | 707 | function is_flagged($content_id, $uid = NULL, $sid = NULL) { |
708 | 708 | return (bool) $this->get_flagging_record($content_id, $uid, $sid); |
@@ -875,7 +875,7 @@ discard block |
||
875 | 875 | * E.g., do `print $flag->get_label('title')` instead of `print |
876 | 876 | * $flag->title`. |
877 | 877 | * |
878 | - * @param $label |
|
878 | + * @param string $label |
|
879 | 879 | * The label to get, e.g. 'title', 'flag_short', 'unflag_short', etc. |
880 | 880 | * @param $content_id |
881 | 881 | * The ID in whose context to interpret tokens. If not given, only global |
@@ -1147,7 +1147,7 @@ discard block |
||
1147 | 1147 | * call flag_get_flag($this->name) again. |
1148 | 1148 | * |
1149 | 1149 | * @return |
1150 | - * TRUE if the flag was reverted successfully; FALSE if there was an error; |
|
1150 | + boolean|null TRUE if the flag was reverted successfully; FALSE if there was an error; |
|
1151 | 1151 | * NULL if this flag overrides no default flag. |
1152 | 1152 | */ |
1153 | 1153 | function revert() { |
@@ -1787,6 +1787,7 @@ discard block |
||
1787 | 1787 | |
1788 | 1788 | /** |
1789 | 1789 | * Returns the actual storage object compatible with the flag. |
1790 | + * @param flag_flag $flag |
|
1790 | 1791 | */ |
1791 | 1792 | static function factory($flag) { |
1792 | 1793 | if ($flag->global) { |
@@ -1204,7 +1204,7 @@ discard block |
||
1204 | 1204 | /** |
1205 | 1205 | * Get flag counts for all flags on a node. |
1206 | 1206 | * |
1207 | - * @param $content_type |
|
1207 | + * @param null|string $content_type |
|
1208 | 1208 | * The content type (usually 'node'). |
1209 | 1209 | * @param $content_id |
1210 | 1210 | * The content ID (usually the node ID). |
@@ -1400,7 +1400,7 @@ discard block |
||
1400 | 1400 | * The subtype (node type) being checked. |
1401 | 1401 | * |
1402 | 1402 | * @return |
1403 | - * TRUE if the flag is enabled for this type and subtype. |
|
1403 | + boolean TRUE if the flag is enabled for this type and subtype. |
|
1404 | 1404 | */ |
1405 | 1405 | function _flag_content_enabled($flag, $content_type, $content_subtype = NULL) { |
1406 | 1406 | $return = $flag->content_type == $content_type && (!isset($content_subtype) || in_array($content_subtype, $flag->types)); |
@@ -1481,7 +1481,7 @@ discard block |
||
1481 | 1481 | /** |
1482 | 1482 | * Find what a user has flagged, either a single node or on the entire site. |
1483 | 1483 | * |
1484 | - * @param $content_type |
|
1484 | + * @param null|string $content_type |
|
1485 | 1485 | * The type of content that will be retrieved. Usually 'node'. |
1486 | 1486 | * @param $content_id |
1487 | 1487 | * Optional. The content ID to check for flagging. If none given, all |