Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
03/04/2017 06:26:55 PM (5 years ago)
Author:
tw2113
Message:

Cleanup from recent Scrutinizer review around documentation and param/return types.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-notifications/classes/class-bp-notifications-notification.php

    r11029 r11447  
    837837     *                           determine which rows should be updated. Of the format
    838838     *                           array( 'item_id' => 7, 'component_action' => 'members', ).
    839      * @return int|bool Number of rows updated on success, false on failure.
     839     * @return int|false Number of rows updated on success, false on failure.
    840840     */
    841841    public static function update( $update_args = array(), $where_args = array() ) {
     
    872872     *                    which rows should be deleted.  Of the format
    873873     *                    array( 'item_id' => 7, 'component_action' => 'members', ).
    874      * @return int|bool Number of rows deleted on success, false on failure.
     874     * @return int|false Number of rows deleted on success, false on failure.
    875875     */
    876876    public static function delete( $args = array() ) {
     
    902902     *
    903903     * @param int $id ID of the notification item to be deleted.
    904      * @return bool True on success, false on failure.
     904     * @return int|false True on success, false on failure.
    905905     */
    906906    public static function delete_by_id( $id ) {
     
    10171017     * @param string $component_action  Name of the component action.
    10181018     * @param int    $secondary_item_id The ID of the secondary item.
    1019      * @return bool|int False on failure to update. ID on success.
     1019     * @return int|false False on failure to update. ID on success.
    10201020     */
    10211021    public static function mark_all_for_user( $user_id, $is_new = 0, $item_id = 0, $component_name = '', $component_action = '', $secondary_item_id = 0 ) {
     
    10601060     * @param string $component_action  Name of the component action.
    10611061     * @param int    $secondary_item_id The ID of the secondary item.
    1062      * @return bool|int
     1062     * @return int|false
    10631063     */
    10641064    public static function mark_all_from_user( $user_id, $is_new = 0, $component_name = '', $component_action = '', $secondary_item_id = 0 ) {
     
    11041104     * @param int    $secondary_item_id Optional. ID of the secondary
    11051105     *                                  associated item.
    1106      * @return bool|int
     1106     * @return int|false
    11071107     */
    11081108    public static function mark_all_by_type( $item_id, $is_new = 0, $component_name = '', $component_action = '', $secondary_item_id = 0 ) {
Note: See TracChangeset for help on using the changeset viewer.