Expirable_Items.php
1 year ago
Expirables.php
9 months ago
REST_Expirable_Items_Controller.php
1 year ago
REST_Expirable_Items_Controller.php
170 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Class Google\Site_Kit\Core\Expirables\REST_Expirable_Items_Controller |
| 4 | * |
| 5 | * @package Google\Site_Kit\Core\Expirables |
| 6 | * @copyright 2024 Google LLC |
| 7 | * @license https://www.apache.org/licenses/LICENSE-2.0 Apache License 2.0 |
| 8 | * @link https://sitekit.withgoogle.com |
| 9 | */ |
| 10 | |
| 11 | namespace Google\Site_Kit\Core\Expirables; |
| 12 | |
| 13 | use Google\Site_Kit\Core\Expirables\Expirable_Items; |
| 14 | use Google\Site_Kit\Core\Permissions\Permissions; |
| 15 | use Google\Site_Kit\Core\REST_API\REST_Route; |
| 16 | use Google\Site_Kit\Core\REST_API\REST_Routes; |
| 17 | use WP_Error; |
| 18 | use WP_REST_Request; |
| 19 | use WP_REST_Response; |
| 20 | use WP_REST_Server; |
| 21 | |
| 22 | /** |
| 23 | * Class for handling expirable items rest routes. |
| 24 | * |
| 25 | * @since 1.128.0 |
| 26 | * @access private |
| 27 | * @ignore |
| 28 | */ |
| 29 | class REST_Expirable_Items_Controller { |
| 30 | |
| 31 | /** |
| 32 | * Expirable_Items instance. |
| 33 | * |
| 34 | * @since 1.128.0 |
| 35 | * @var Expirable_Items |
| 36 | */ |
| 37 | protected $expirable_items; |
| 38 | |
| 39 | /** |
| 40 | * Constructor. |
| 41 | * |
| 42 | * @since 1.128.0 |
| 43 | * |
| 44 | * @param Expirable_Items $expirable_items Expirable items instance. |
| 45 | */ |
| 46 | public function __construct( Expirable_Items $expirable_items ) { |
| 47 | $this->expirable_items = $expirable_items; |
| 48 | } |
| 49 | |
| 50 | /** |
| 51 | * Registers functionality through WordPress hooks. |
| 52 | * |
| 53 | * @since 1.128.0 |
| 54 | */ |
| 55 | public function register() { |
| 56 | add_filter( |
| 57 | 'googlesitekit_rest_routes', |
| 58 | function ( $routes ) { |
| 59 | return array_merge( $routes, $this->get_rest_routes() ); |
| 60 | } |
| 61 | ); |
| 62 | |
| 63 | add_filter( |
| 64 | 'googlesitekit_apifetch_preload_paths', |
| 65 | function ( $paths ) { |
| 66 | return array_merge( |
| 67 | $paths, |
| 68 | array( |
| 69 | '/' . REST_Routes::REST_ROOT . '/core/user/data/expirable-items', |
| 70 | ) |
| 71 | ); |
| 72 | } |
| 73 | ); |
| 74 | } |
| 75 | |
| 76 | /** |
| 77 | * Gets REST route instances. |
| 78 | * |
| 79 | * @since 1.128.0 |
| 80 | * |
| 81 | * @return REST_Route[] List of REST_Route objects. |
| 82 | */ |
| 83 | protected function get_rest_routes() { |
| 84 | $can_manage_expirable_item = function () { |
| 85 | return current_user_can( Permissions::VIEW_DASHBOARD ); |
| 86 | }; |
| 87 | |
| 88 | return array( |
| 89 | new REST_Route( |
| 90 | 'core/user/data/expirable-items', |
| 91 | array( |
| 92 | 'methods' => WP_REST_Server::READABLE, |
| 93 | 'callback' => function () { |
| 94 | return new WP_REST_Response( $this->expirable_items->get() ); |
| 95 | }, |
| 96 | 'permission_callback' => $can_manage_expirable_item, |
| 97 | ) |
| 98 | ), |
| 99 | new REST_Route( |
| 100 | 'core/user/data/set-expirable-item-timers', |
| 101 | array( |
| 102 | 'methods' => WP_REST_Server::CREATABLE, |
| 103 | 'callback' => function ( WP_REST_Request $request ) { |
| 104 | $data = $request['data']; |
| 105 | |
| 106 | if ( empty( $data ) || ! is_array( $data ) ) { |
| 107 | return new WP_Error( |
| 108 | 'missing_required_param', |
| 109 | /* translators: %s: Missing parameter name */ |
| 110 | sprintf( __( 'Request parameter is empty: %s.', 'google-site-kit' ), 'items' ), |
| 111 | array( 'status' => 400 ) |
| 112 | ); |
| 113 | } |
| 114 | |
| 115 | foreach ( $data as $datum ) { |
| 116 | if ( empty( $datum['slug'] ) ) { |
| 117 | return new WP_Error( |
| 118 | 'missing_required_param', |
| 119 | /* translators: %s: Missing parameter name */ |
| 120 | sprintf( __( 'Request parameter is empty: %s.', 'google-site-kit' ), 'slug' ), |
| 121 | array( 'status' => 400 ) |
| 122 | ); |
| 123 | } |
| 124 | |
| 125 | $expiration = null; |
| 126 | if ( isset( $datum['expiration'] ) && intval( $datum['expiration'] ) > 0 ) { |
| 127 | $expiration = $datum['expiration']; |
| 128 | } |
| 129 | |
| 130 | if ( ! $expiration ) { |
| 131 | return new WP_Error( |
| 132 | 'missing_required_param', |
| 133 | /* translators: %s: Missing parameter name */ |
| 134 | sprintf( __( 'Request parameter is invalid: %s.', 'google-site-kit' ), 'expiration' ), |
| 135 | array( 'status' => 400 ) |
| 136 | ); |
| 137 | } |
| 138 | |
| 139 | $this->expirable_items->add( $datum['slug'], $expiration ); |
| 140 | } |
| 141 | |
| 142 | return new WP_REST_Response( $this->expirable_items->get() ); |
| 143 | }, |
| 144 | 'permission_callback' => $can_manage_expirable_item, |
| 145 | 'args' => array( |
| 146 | 'data' => array( |
| 147 | 'type' => 'array', |
| 148 | 'required' => true, |
| 149 | 'items' => array( |
| 150 | 'type' => 'object', |
| 151 | 'additionalProperties' => false, |
| 152 | 'properties' => array( |
| 153 | 'slug' => array( |
| 154 | 'type' => 'string', |
| 155 | 'required' => true, |
| 156 | ), |
| 157 | 'expiration' => array( |
| 158 | 'type' => 'integer', |
| 159 | 'required' => true, |
| 160 | ), |
| 161 | ), |
| 162 | ), |
| 163 | ), |
| 164 | ), |
| 165 | ) |
| 166 | ), |
| 167 | ); |
| 168 | } |
| 169 | } |
| 170 |