class-give-donor-wall.php
307 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' => 'array', |
| 96 | 'default' => [], |
| 97 | ], |
| 98 | 'ids' => [ |
| 99 | 'type' => 'array', |
| 100 | 'default' => [], |
| 101 | ], |
| 102 | 'categories' => [ |
| 103 | 'type' => 'array', |
| 104 | 'default' => [], |
| 105 | ], |
| 106 | 'tags' => [ |
| 107 | 'type' => 'array', |
| 108 | 'default' => [], |
| 109 | ], |
| 110 | 'orderBy' => [ |
| 111 | 'type' => 'string', |
| 112 | 'default' => 'post_date', |
| 113 | ], |
| 114 | 'order' => [ |
| 115 | 'type' => 'string', |
| 116 | 'default' => 'DESC', |
| 117 | ], |
| 118 | 'paged' => [ |
| 119 | 'type' => 'string', |
| 120 | 'default' => '1', |
| 121 | ], |
| 122 | 'columns' => [ |
| 123 | 'type' => 'string', |
| 124 | 'default' => '3', |
| 125 | ], |
| 126 | 'showAvatar' => [ |
| 127 | 'type' => 'boolean', |
| 128 | 'default' => true, |
| 129 | ], |
| 130 | 'showName' => [ |
| 131 | 'type' => 'boolean', |
| 132 | 'default' => true, |
| 133 | ], |
| 134 | 'showCompanyName' => [ |
| 135 | 'type' => 'boolean', |
| 136 | 'default' => false, |
| 137 | ], |
| 138 | 'showForm' => [ |
| 139 | 'type' => 'boolean', |
| 140 | 'default' => true, |
| 141 | ], |
| 142 | 'showTotal' => [ |
| 143 | 'type' => 'boolean', |
| 144 | 'default' => true, |
| 145 | ], |
| 146 | 'showComments' => [ |
| 147 | 'type' => 'boolean', |
| 148 | 'default' => true, |
| 149 | ], |
| 150 | 'showAnonymous' => [ |
| 151 | 'type' => 'boolean', |
| 152 | 'default' => true, |
| 153 | ], |
| 154 | 'onlyComments' => [ |
| 155 | 'type' => 'boolean', |
| 156 | 'default' => false, |
| 157 | ], |
| 158 | 'commentLength' => [ |
| 159 | 'type' => 'string', |
| 160 | 'default' => '80', |
| 161 | ], |
| 162 | 'readMoreText' => [ |
| 163 | 'type' => 'string', |
| 164 | 'default' => __( 'Read more', 'give' ), |
| 165 | ], |
| 166 | 'loadMoreText' => [ |
| 167 | 'type' => 'string', |
| 168 | 'default' => __( 'Load more', 'give' ), |
| 169 | ], |
| 170 | 'avatarSize' => [ |
| 171 | 'type' => 'string', |
| 172 | 'default' => '75', |
| 173 | ], |
| 174 | 'toggleOptions' => [ |
| 175 | 'type' => 'string', |
| 176 | 'default' => 'Donor info', |
| 177 | ], |
| 178 | 'filterOptions' => [ |
| 179 | 'type' => 'string', |
| 180 | 'default' => 'ids', |
| 181 | ], |
| 182 | 'color' => [ |
| 183 | 'type' => 'string', |
| 184 | 'default' => '#219653', |
| 185 | ], |
| 186 | 'showTributes' => [ |
| 187 | 'type' => 'boolean', |
| 188 | 'default' => false, |
| 189 | ], |
| 190 | 'showTimestamp' => [ |
| 191 | 'type' => 'boolean', |
| 192 | 'default' => true, |
| 193 | ], |
| 194 | ], |
| 195 | ] |
| 196 | ); |
| 197 | } |
| 198 | |
| 199 | /** |
| 200 | * Block render callback |
| 201 | * |
| 202 | * @since 3.1.0 Use static function on array_map callback to pass the id as reference for _give_redirect_form_id to prevent warnings on PHP 8.0.1 or plus |
| 203 | * |
| 204 | * @param array $attributes Block parameters. |
| 205 | * |
| 206 | * @access public |
| 207 | * @return string; |
| 208 | */ |
| 209 | public function render_block( $attributes ) { |
| 210 | $avatarSize = absint( $attributes['avatarSize'] ); |
| 211 | |
| 212 | $parameters = [ |
| 213 | 'donors_per_page' => absint( $attributes['donorsPerPage'] ), |
| 214 | 'form_id' => implode(',', |
| 215 | array_map( |
| 216 | static function ($id) { |
| 217 | _give_redirect_form_id($id); |
| 218 | |
| 219 | return $id; |
| 220 | }, |
| 221 | $this->getAsArray($attributes['formID']) |
| 222 | ) |
| 223 | ), |
| 224 | 'ids' => implode(',', $this->getAsArray($attributes['ids'] ) ), |
| 225 | 'cats' => implode(',', $this->getAsArray($attributes['categories'] ) ), |
| 226 | 'tags' => implode(',', $this->getAsArray($attributes['tags'] ) ), |
| 227 | 'orderby' => $attributes['orderBy'], |
| 228 | 'order' => $attributes['order'], |
| 229 | 'pages' => absint( $attributes['paged'] ), |
| 230 | 'columns' => $attributes['columns'], |
| 231 | 'show_avatar' => $attributes['showAvatar'], |
| 232 | 'show_name' => $attributes['showName'], |
| 233 | 'show_company_name' => $attributes['showCompanyName'], |
| 234 | 'show_form' => $attributes['showForm'], |
| 235 | 'show_total' => $attributes['showTotal'], |
| 236 | 'show_comments' => $attributes['showComments'], |
| 237 | 'show_tributes' => $attributes['showTributes'], |
| 238 | 'anonymous' => $attributes['showAnonymous'], |
| 239 | 'comment_length' => absint( $attributes['commentLength'] ), |
| 240 | 'only_comments' => $attributes['onlyComments'], |
| 241 | 'readmore_text' => $attributes['readMoreText'], |
| 242 | 'loadmore_text' => $attributes['loadMoreText'], |
| 243 | 'avatar_size' => $avatarSize ?: 75, |
| 244 | 'color' => $attributes['color'], |
| 245 | 'show_time' => $attributes['showTimestamp'], |
| 246 | ]; |
| 247 | |
| 248 | $html = Give_Donor_Wall::get_instance()->render_shortcode( $parameters ); |
| 249 | $html = ! empty( $html ) ? $html : $this->blank_slate(); |
| 250 | |
| 251 | return $html; |
| 252 | } |
| 253 | |
| 254 | |
| 255 | /** |
| 256 | * @since 2.25.0 |
| 257 | * |
| 258 | * @param string|array $value |
| 259 | * @return array |
| 260 | */ |
| 261 | private function getAsArray($value) { |
| 262 | if ( is_array($value) ) { |
| 263 | return $value; |
| 264 | } |
| 265 | |
| 266 | // Backward compatibility |
| 267 | if (strpos($value, ',')) { |
| 268 | return explode(',', $value); |
| 269 | } |
| 270 | |
| 271 | return [$value]; |
| 272 | } |
| 273 | |
| 274 | /** |
| 275 | * Return formatted notice when shortcode returns an empty string |
| 276 | * |
| 277 | * @since 2.4.0 |
| 278 | * |
| 279 | * @return string |
| 280 | */ |
| 281 | private function blank_slate() { |
| 282 | if ( ! defined( 'REST_REQUEST' ) ) { |
| 283 | return ''; |
| 284 | } |
| 285 | |
| 286 | ob_start(); |
| 287 | |
| 288 | $content = [ |
| 289 | 'image_url' => GIVE_PLUGIN_URL . 'build/assets/dist/images/give-icon-full-circle.svg', |
| 290 | 'image_alt' => __( 'GiveWP Icon', 'give' ), |
| 291 | 'heading' => __( 'No donors found.', 'give' ), |
| 292 | 'help' => sprintf( |
| 293 | /* translators: 1: Opening anchor tag. 2: Closing anchor tag. */ |
| 294 | __( 'Need help? Learn more about %1$sDonors%2$s.', 'give' ), |
| 295 | '<a href="http://docs.givewp.com/core-donors/">', |
| 296 | '</a>' |
| 297 | ), |
| 298 | ]; |
| 299 | |
| 300 | include_once GIVE_PLUGIN_DIR . 'includes/admin/views/blank-slate.php'; |
| 301 | |
| 302 | return ob_get_clean(); |
| 303 | } |
| 304 | } |
| 305 | |
| 306 | Give_Donor_Wall_Block::get_instance(); |
| 307 |