cb-transactions-template.php
Table of Contents
Functions
- cb_transactions_get_total_sent_today_notice() : string
- Gets the total number of Confetti Bits that have been sent for the current day and returns a notice to the user.
- cb_transactions_total_sent_today_notice() : mixed
- Output the total number of Confetti Bits that the user has sent for the current day.
- cb_transactions_request_balance() : mixed
- Display the users request balance.
- cb_transactions_get_request_balance_notice() : string
- Get the users request balance notice.
- cb_transactions_request_balance_notice() : mixed
- Output the users request balance notice.
- cb_transactions_get_balances_notice() : string
- CB Transactions Balances Notice
- cb_transactions_balances_notice() : mixed
- CB Transactions Balances Notice
- cb_transactions_get_transfer_balance_notice() : string
- CB Transactions Get Transfer Balance Notice
- cb_transactions_get_balance_notice() : string
- Dynamically gets the markup for the balance notice at the top of the dashboard.
- cb_transactions_balance_notice() : mixed
- Outputs a balance notice of the given type, for the given user.
- cb_transactions_transfer_balance_notice() : mixed
- CB Transactions Transfer Balance Notice
- cb_transactions_get_request_selection() : string
- CB Transactions Get Request Selection
- cb_transactions_request_selection() : mixed
- Outputs markup for the request selector.
- cb_transactions_get_leaderboard_module() : string
- Returns container markup with transactions leaderboard content inside.
- cb_transactions_leaderboard_module() : mixed
- Outputs the markup for the Confetti Bits leaderboard module.
- cb_transactions_get_send_bits_module() : string
- Gets the containerized markup for the send bits module on the Confetti Bits dashboard.
- cb_transactions_send_bits_module() : mixed
- Outputs the markup for the send bits module.
- cb_transactions_get_formatted_leaderboard() : string
- Returns a string of markup that contains listings for the top 15 users with the most Confetti Bits.
- cb_transactions_leaderboard() : mixed
- Outputs markup for the transactions leaderboard.
- cb_transactions_get_import_bda_module() : string
- Formats the markup for the "Import Birthdays" module.
- cb_import_bda_module() : mixed
- Outputs the "Import B-Days & Anniversaries" markup.
- cb_transactions_get_spot_bonus_module() : mixed
- cb_transactions_get_volunteers_module() : mixed
- cb_transactions_spot_bonus_table_module() : mixed
- Adds a table for spot bonuses to the transactions tab.
- cb_transactions_spot_bonus_module() : mixed
- Adds the spot bonus form to the transactions tab.
- cb_transactions_volunteer_hours_module() : mixed
Functions
cb_transactions_get_total_sent_today_notice()
Gets the total number of Confetti Bits that have been sent for the current day and returns a notice to the user.
cb_transactions_get_total_sent_today_notice() : string
Tags
Return values
string —$notice The notice to be displayed to the user.
cb_transactions_total_sent_today_notice()
Output the total number of Confetti Bits that the user has sent for the current day.
cb_transactions_total_sent_today_notice() : mixed
Tags
cb_transactions_request_balance()
Display the users request balance.
cb_transactions_request_balance([int $user_id = 0 ]) : mixed
Parameters
- $user_id : int = 0
-
The user ID.
Tags
cb_transactions_get_request_balance_notice()
Get the users request balance notice.
cb_transactions_get_request_balance_notice([int $user_id = 0 ]) : string
Parameters
- $user_id : int = 0
-
The user ID.
Tags
Return values
string —The users request balance notice.
cb_transactions_request_balance_notice()
Output the users request balance notice.
cb_transactions_request_balance_notice() : mixed
Tags
cb_transactions_get_balances_notice()
CB Transactions Balances Notice
cb_transactions_get_balances_notice([int $user_id = 0 ]) : string
Assemble the markup for both the user's transfer balance and their request balance.
Parameters
- $user_id : int = 0
-
The id of the user whose balance notice we're assembling. Defaults to current logged-in user.
Tags
Return values
string —$notice the formatted notice markup.
cb_transactions_balances_notice()
CB Transactions Balances Notice
cb_transactions_balances_notice() : mixed
Display the users balances above the dashboard.
Tags
cb_transactions_get_transfer_balance_notice()
CB Transactions Get Transfer Balance Notice
cb_transactions_get_transfer_balance_notice([int $user_id = 0 ]) : string
Assemble the transfer balance markup for the user's transfer balance notice.
Parameters
- $user_id : int = 0
-
The id of the user whose balance notice we're assembling. Defaults to current logged-in user.
Tags
Return values
string —$notice the formatted notice markup.
cb_transactions_get_balance_notice()
Dynamically gets the markup for the balance notice at the top of the dashboard.
cb_transactions_get_balance_notice([string $type = '' ][, int $user_id = 0 ]) : string
Parameters
- $type : string = ''
-
The type of balance notice to return.
- $user_id : int = 0
-
The ID for the user whose balance we're retrieving.
Tags
Return values
string —The markup for the balance notice.
cb_transactions_balance_notice()
Outputs a balance notice of the given type, for the given user.
cb_transactions_balance_notice([mixed $type = '' ][, mixed $user_id = 0 ]) : mixed
Parameters
- $type : mixed = ''
- $user_id : mixed = 0
Tags
cb_transactions_transfer_balance_notice()
CB Transactions Transfer Balance Notice
cb_transactions_transfer_balance_notice() : mixed
Output markup that shows a user's transfer balance.
Tags
cb_transactions_get_request_selection()
CB Transactions Get Request Selection
cb_transactions_get_request_selection() : string
Get markup for the Request Selection Input
Tags
Return values
string —The formatted select input.
cb_transactions_request_selection()
Outputs markup for the request selector.
cb_transactions_request_selection() : mixed
Tags
cb_transactions_get_leaderboard_module()
Returns container markup with transactions leaderboard content inside.
cb_transactions_get_leaderboard_module() : string
Tags
Return values
string —The formatted markup
cb_transactions_leaderboard_module()
Outputs the markup for the Confetti Bits leaderboard module.
cb_transactions_leaderboard_module() : mixed
Tags
cb_transactions_get_send_bits_module()
Gets the containerized markup for the send bits module on the Confetti Bits dashboard.
cb_transactions_get_send_bits_module() : string
Tags
Return values
string —The formatted markup.
cb_transactions_send_bits_module()
Outputs the markup for the send bits module.
cb_transactions_send_bits_module() : mixed
Tags
cb_transactions_get_formatted_leaderboard()
Returns a string of markup that contains listings for the top 15 users with the most Confetti Bits.
cb_transactions_get_formatted_leaderboard() : string
Tags
Return values
string —The formatted markup.
cb_transactions_leaderboard()
Outputs markup for the transactions leaderboard.
cb_transactions_leaderboard() : mixed
Tags
cb_transactions_get_import_bda_module()
Formats the markup for the "Import Birthdays" module.
cb_transactions_get_import_bda_module() : string
Uses a bunch of our new templating structure to clean up some of the excess markup lying around here.
Tags
Return values
string —The formatted markup.
cb_import_bda_module()
Outputs the "Import B-Days & Anniversaries" markup.
cb_import_bda_module() : mixed
Tags
cb_transactions_get_spot_bonus_module()
cb_transactions_get_spot_bonus_module() : mixed
cb_transactions_get_volunteers_module()
cb_transactions_get_volunteers_module() : mixed
cb_transactions_spot_bonus_table_module()
Adds a table for spot bonuses to the transactions tab.
cb_transactions_spot_bonus_table_module() : mixed
Tags
cb_transactions_spot_bonus_module()
Adds the spot bonus form to the transactions tab.
cb_transactions_spot_bonus_module() : mixed
Tags
cb_transactions_volunteer_hours_module()
cb_transactions_volunteer_hours_module() : mixed