class-give-api-v2.php
210 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Give API V2 |
| 4 | * |
| 5 | * @package Give |
| 6 | * @subpackage Classes/API |
| 7 | * @copyright Copyright (c) 2018, GiveWP |
| 8 | * @license https://opensource.org/licenses/gpl-license GNU Public License |
| 9 | * @since 2.1 |
| 10 | */ |
| 11 | |
| 12 | // Exit if accessed directly. |
| 13 | if ( ! defined( 'ABSPATH' ) ) { |
| 14 | exit; |
| 15 | } |
| 16 | |
| 17 | |
| 18 | /** |
| 19 | * Give_API_V2 Class |
| 20 | * |
| 21 | * The base version API class |
| 22 | * |
| 23 | * @since 2.1 |
| 24 | */ |
| 25 | class Give_API_V2 { |
| 26 | /** |
| 27 | * API base prefix |
| 28 | * |
| 29 | * @since 2.1 |
| 30 | * @access private |
| 31 | * |
| 32 | * @var string |
| 33 | */ |
| 34 | private $rest_base = 'give-api/v2'; |
| 35 | |
| 36 | /** |
| 37 | * Instance. |
| 38 | * |
| 39 | * @since 2.1 |
| 40 | * @access private |
| 41 | * |
| 42 | * @var Give_API_V2 |
| 43 | */ |
| 44 | private static $instance; |
| 45 | |
| 46 | /** |
| 47 | * Singleton pattern. |
| 48 | * |
| 49 | * @since 2.1 |
| 50 | * @access private |
| 51 | */ |
| 52 | private function __construct() { |
| 53 | } |
| 54 | |
| 55 | |
| 56 | /** |
| 57 | * Get instance. |
| 58 | * |
| 59 | * @since 2.1 |
| 60 | * @access public |
| 61 | * @return Give_API_V2 |
| 62 | */ |
| 63 | public static function get_instance() { |
| 64 | if ( null === static::$instance ) { |
| 65 | self::$instance = new static(); |
| 66 | |
| 67 | self::$instance->init(); |
| 68 | } |
| 69 | |
| 70 | return self::$instance; |
| 71 | } |
| 72 | |
| 73 | |
| 74 | /** |
| 75 | * Initialize API |
| 76 | * |
| 77 | * @since 2.1 |
| 78 | * @access private |
| 79 | */ |
| 80 | private function init() { |
| 81 | // Setup hooks. |
| 82 | add_action( 'rest_api_init', array( $this, 'register_routes' ) ); |
| 83 | add_action( 'wp_enqueue_scripts', array( $this, 'localize_script' ), 999 ); |
| 84 | add_action( 'admin_enqueue_scripts', array( $this, 'localize_script' ), 999 ); |
| 85 | } |
| 86 | |
| 87 | |
| 88 | /** |
| 89 | * Register API routes |
| 90 | * Note: only for internal purpose. |
| 91 | * |
| 92 | * @todo : prevent cross domain api request |
| 93 | * |
| 94 | * @since 2.1 |
| 95 | * @access private |
| 96 | */ |
| 97 | public function register_routes() { |
| 98 | register_rest_route( |
| 99 | $this->rest_base, |
| 100 | '/form/(?P<id>[\d]+)', |
| 101 | array( |
| 102 | 'methods' => 'GET', |
| 103 | 'callback' => array( $this, 'get_forms_data' ), |
| 104 | ) |
| 105 | ); |
| 106 | |
| 107 | register_rest_route( |
| 108 | $this->rest_base, |
| 109 | '/form-grid', |
| 110 | array( |
| 111 | 'methods' => 'GET', |
| 112 | 'callback' => array( $this, 'get_donation_grid' ), |
| 113 | ) |
| 114 | ); |
| 115 | |
| 116 | register_rest_route( |
| 117 | $this->rest_base, |
| 118 | '/donor-wall', |
| 119 | array( |
| 120 | 'methods' => 'GET', |
| 121 | 'callback' => array( $this, 'get_donor_wall' ), |
| 122 | ) |
| 123 | ); |
| 124 | } |
| 125 | |
| 126 | /** |
| 127 | * Add api localize data |
| 128 | * |
| 129 | * @since 2.1 |
| 130 | * @access public |
| 131 | */ |
| 132 | public function localize_script() { |
| 133 | $data = array( |
| 134 | 'root' => esc_url_raw( self::get_rest_api() ), |
| 135 | 'rest_base' => $this->rest_base, |
| 136 | ); |
| 137 | |
| 138 | if ( is_admin() ) { |
| 139 | wp_localize_script( 'give-admin-scripts', 'giveApiSettings', $data ); |
| 140 | } else { |
| 141 | wp_localize_script( 'give', 'giveApiSettings', $data ); |
| 142 | } |
| 143 | } |
| 144 | |
| 145 | /** |
| 146 | * Rest fetch form data callback |
| 147 | * |
| 148 | * @param WP_REST_Request $request |
| 149 | * |
| 150 | * @access public |
| 151 | * @return array|mixed|object |
| 152 | */ |
| 153 | public function get_forms_data( $request ) { |
| 154 | $parameters = $request->get_params(); |
| 155 | |
| 156 | // Bailout |
| 157 | if ( ! isset( $parameters['id'] ) || empty( $parameters['id'] ) ) { |
| 158 | return array( 'error' => 'no_parameter_given' ); |
| 159 | } |
| 160 | |
| 161 | return give_form_shortcode( $parameters ); |
| 162 | } |
| 163 | |
| 164 | /** |
| 165 | * Rest fetch form data callback |
| 166 | * |
| 167 | * @param WP_REST_Request $request |
| 168 | * |
| 169 | * @access public |
| 170 | * @return array|mixed|object |
| 171 | */ |
| 172 | public function get_donation_grid( $request ) { |
| 173 | $parameters = $request->get_params(); |
| 174 | |
| 175 | return give_form_grid_shortcode( $parameters ); |
| 176 | } |
| 177 | |
| 178 | /** |
| 179 | * Rest fetch form data callback |
| 180 | * |
| 181 | * @param WP_REST_Request $request |
| 182 | * |
| 183 | * @access public |
| 184 | * @return array|mixed|object |
| 185 | */ |
| 186 | public function get_donor_wall( $request ) { |
| 187 | $parameters = $request->get_params(); |
| 188 | |
| 189 | return Give_Donor_Wall::get_instance()->render_shortcode( $parameters ); |
| 190 | } |
| 191 | |
| 192 | /** |
| 193 | * Get api reset url |
| 194 | * |
| 195 | * @since 2.1 |
| 196 | * @access public |
| 197 | * |
| 198 | * @param int $blog_id Optional. Blog ID. Default of null returns URL for current blog. |
| 199 | * @param string $path Optional. REST route. Default '/'. |
| 200 | * @param string $scheme Optional. Sanitization scheme. Default 'rest'. |
| 201 | * |
| 202 | * @return string Full URL to the endpoint. |
| 203 | */ |
| 204 | public static function get_rest_api( $blog_id = null, $path = '/', $scheme = 'rest' ) { |
| 205 | return trailingslashit( get_rest_url( $blog_id, $path, $scheme ) . self::$instance->rest_base ); |
| 206 | } |
| 207 | } |
| 208 | |
| 209 | Give_API_V2::get_instance(); |
| 210 |