class-give-donor-wall.php
243 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Give Donor Wall Block Class |
| 4 | * |
| 5 | * @package Give |
| 6 | * @subpackage Classes/Blocks |
| 7 | * @copyright Copyright (c) 2016, GiveWP |
| 8 | * @license https://opensource.org/licenses/gpl-license GNU Public License |
| 9 | * @since 2.3.0 |
| 10 | */ |
| 11 | |
| 12 | // Exit if accessed directly. |
| 13 | if ( ! defined( 'ABSPATH' ) ) { |
| 14 | exit; |
| 15 | } |
| 16 | |
| 17 | /** |
| 18 | * Give_Donor_Wall_Block Class. |
| 19 | * |
| 20 | * This class handles donation forms block. |
| 21 | * |
| 22 | * @since 2.3.0 |
| 23 | */ |
| 24 | class Give_Donor_Wall_Block { |
| 25 | /** |
| 26 | * Instance. |
| 27 | * |
| 28 | * @since |
| 29 | * @access private |
| 30 | * @var Give_Donor_Wall_Block |
| 31 | */ |
| 32 | private static $instance; |
| 33 | |
| 34 | /** |
| 35 | * Singleton pattern. |
| 36 | * |
| 37 | * @since |
| 38 | * @access private |
| 39 | */ |
| 40 | private function __construct() { |
| 41 | } |
| 42 | |
| 43 | |
| 44 | /** |
| 45 | * Get instance. |
| 46 | * |
| 47 | * @since |
| 48 | * @access public |
| 49 | * @return Give_Donor_Wall_Block |
| 50 | */ |
| 51 | public static function get_instance() { |
| 52 | if ( null === static::$instance ) { |
| 53 | self::$instance = new static(); |
| 54 | |
| 55 | self::$instance->init(); |
| 56 | } |
| 57 | |
| 58 | return self::$instance; |
| 59 | } |
| 60 | |
| 61 | /** |
| 62 | * Class Constructor |
| 63 | * |
| 64 | * Set up the Give Donation Grid Block class. |
| 65 | * |
| 66 | * @since 2.3.0 |
| 67 | * @access private |
| 68 | */ |
| 69 | private function init() { |
| 70 | add_action( 'init', [ $this, 'register_block' ], 999 ); |
| 71 | } |
| 72 | |
| 73 | /** |
| 74 | * Register block |
| 75 | * |
| 76 | * @access public |
| 77 | */ |
| 78 | public function register_block() { |
| 79 | // Bailout. |
| 80 | if ( ! function_exists( 'register_block_type' ) ) { |
| 81 | return; |
| 82 | } |
| 83 | |
| 84 | // Register block. |
| 85 | register_block_type( |
| 86 | 'give/donor-wall', |
| 87 | [ |
| 88 | 'render_callback' => [ $this, 'render_block' ], |
| 89 | 'attributes' => [ |
| 90 | 'donorsPerPage' => [ |
| 91 | 'type' => 'string', |
| 92 | 'default' => '12', |
| 93 | ], |
| 94 | 'formID' => [ |
| 95 | 'type' => 'string', |
| 96 | 'default' => '0', |
| 97 | ], |
| 98 | 'ids' => [ |
| 99 | 'type' => 'string', |
| 100 | 'default' => '', |
| 101 | ], |
| 102 | 'orderBy' => [ |
| 103 | 'type' => 'string', |
| 104 | 'default' => 'post_date', |
| 105 | ], |
| 106 | 'order' => [ |
| 107 | 'type' => 'string', |
| 108 | 'default' => 'DESC', |
| 109 | ], |
| 110 | 'paged' => [ |
| 111 | 'type' => 'string', |
| 112 | 'default' => '1', |
| 113 | ], |
| 114 | 'columns' => [ |
| 115 | 'type' => 'string', |
| 116 | 'default' => 'best-fit', |
| 117 | ], |
| 118 | 'showAvatar' => [ |
| 119 | 'type' => 'boolean', |
| 120 | 'default' => true, |
| 121 | ], |
| 122 | 'showName' => [ |
| 123 | 'type' => 'boolean', |
| 124 | 'default' => true, |
| 125 | ], |
| 126 | 'showCompanyName' => [ |
| 127 | 'type' => 'boolean', |
| 128 | 'default' => false, |
| 129 | ], |
| 130 | 'showTotal' => [ |
| 131 | 'type' => 'boolean', |
| 132 | 'default' => true, |
| 133 | ], |
| 134 | 'showDate' => [ |
| 135 | 'type' => 'boolean', |
| 136 | 'default' => true, |
| 137 | ], |
| 138 | 'showComments' => [ |
| 139 | 'type' => 'boolean', |
| 140 | 'default' => true, |
| 141 | ], |
| 142 | 'showAnonymous' => [ |
| 143 | 'type' => 'boolean', |
| 144 | 'default' => true, |
| 145 | ], |
| 146 | 'onlyComments' => [ |
| 147 | 'type' => 'boolean', |
| 148 | 'default' => false, |
| 149 | ], |
| 150 | 'commentLength' => [ |
| 151 | 'type' => 'string', |
| 152 | 'default' => '140', |
| 153 | ], |
| 154 | 'readMoreText' => [ |
| 155 | 'type' => 'string', |
| 156 | 'default' => __( 'Read more', 'give' ), |
| 157 | ], |
| 158 | 'loadMoreText' => [ |
| 159 | 'type' => 'string', |
| 160 | 'default' => __( 'Load more', 'give' ), |
| 161 | ], |
| 162 | 'avatarSize' => [ |
| 163 | 'type' => 'string', |
| 164 | 'default' => '60', |
| 165 | ], |
| 166 | ], |
| 167 | ] |
| 168 | ); |
| 169 | } |
| 170 | |
| 171 | /** |
| 172 | * Block render callback |
| 173 | * |
| 174 | * @param array $attributes Block parameters. |
| 175 | * |
| 176 | * @access public |
| 177 | * @return string; |
| 178 | */ |
| 179 | public function render_block( $attributes ) { |
| 180 | $avatarSize = absint( $attributes['avatarSize'] ); |
| 181 | |
| 182 | $parameters = [ |
| 183 | 'donors_per_page' => absint( $attributes['donorsPerPage'] ), |
| 184 | 'form_id' => absint( $attributes['formID'] ), |
| 185 | 'ids' => $attributes['ids'], |
| 186 | 'orderby' => $attributes['orderBy'], |
| 187 | 'order' => $attributes['order'], |
| 188 | 'pages' => absint( $attributes['paged'] ), |
| 189 | 'columns' => $attributes['columns'], |
| 190 | 'show_avatar' => $attributes['showAvatar'], |
| 191 | 'show_name' => $attributes['showName'], |
| 192 | 'show_company_name' => $attributes['showCompanyName'], |
| 193 | 'show_total' => $attributes['showTotal'], |
| 194 | 'show_time' => $attributes['showDate'], |
| 195 | 'show_comments' => $attributes['showComments'], |
| 196 | 'anonymous' => $attributes['showAnonymous'], |
| 197 | 'comment_length' => absint( $attributes['commentLength'] ), |
| 198 | 'only_comments' => $attributes['onlyComments'], |
| 199 | 'readmore_text' => $attributes['readMoreText'], |
| 200 | 'loadmore_text' => $attributes['loadMoreText'], |
| 201 | 'avatar_size' => $avatarSize ?: 60, |
| 202 | ]; |
| 203 | |
| 204 | $html = Give_Donor_Wall::get_instance()->render_shortcode( $parameters ); |
| 205 | $html = ! empty( $html ) ? $html : $this->blank_slate(); |
| 206 | |
| 207 | return $html; |
| 208 | } |
| 209 | |
| 210 | /** |
| 211 | * Return formatted notice when shortcode returns an empty string |
| 212 | * |
| 213 | * @since 2.4.0 |
| 214 | * |
| 215 | * @return string |
| 216 | */ |
| 217 | private function blank_slate() { |
| 218 | if ( ! defined( 'REST_REQUEST' ) ) { |
| 219 | return ''; |
| 220 | } |
| 221 | |
| 222 | ob_start(); |
| 223 | |
| 224 | $content = [ |
| 225 | 'image_url' => GIVE_PLUGIN_URL . 'assets/dist/images/give-icon-full-circle.svg', |
| 226 | 'image_alt' => __( 'GiveWP Icon', 'give' ), |
| 227 | 'heading' => __( 'No donors found.', 'give' ), |
| 228 | 'help' => sprintf( |
| 229 | /* translators: 1: Opening anchor tag. 2: Closing anchor tag. */ |
| 230 | __( 'Need help? Learn more about %1$sDonors%2$s.', 'give' ), |
| 231 | '<a href="http://docs.givewp.com/core-donors/">', |
| 232 | '</a>' |
| 233 | ), |
| 234 | ]; |
| 235 | |
| 236 | include_once GIVE_PLUGIN_DIR . 'includes/admin/views/blank-slate.php'; |
| 237 | |
| 238 | return ob_get_clean(); |
| 239 | } |
| 240 | } |
| 241 | |
| 242 | Give_Donor_Wall_Block::get_instance(); |
| 243 |