wordpress-develop/tests/phpunit/includes/spy-rest-server.php
Sergey Biryukov 309553e87f Code Modernization: Rename parameters that use reserved keywords in phpunit/includes/spy-rest-server.php.
While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.

This commit renames the `$namespace` parameter to `$route_namespace` in `Spy_REST_Server::register_route()`.

Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947], [54948], [54950], [54951], [54952], [54956], [54959], [54960], [54961], [54962], [54964], [54965], [54969], [54970], [54971], [54972], [54996], [55000], [55011], [55013], [55014], [55015], [55016], [55017], [55020], [55021], [55023].

Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.

git-svn-id: https://develop.svn.wordpress.org/trunk@55027 602fd350-edb4-49c9-b593-d223f7449a82
2023-01-03 12:45:29 +00:00

99 lines
2.8 KiB
PHP

<?php
class Spy_REST_Server extends WP_REST_Server {
public $sent_headers = array();
public $sent_body = '';
public $last_request = null;
public $override_by_default = false;
public $status = null;
/**
* Gets the raw $endpoints data from the server.
*
* @return array
*/
public function get_raw_endpoint_data() {
return $this->endpoints;
}
/**
* Allow calling protected methods from tests.
*
* @param string $method Method to call.
* @param array $args Arguments to pass to the method.
* @return mixed
*/
public function __call( $method, $args ) {
return call_user_func_array( array( $this, $method ), $args );
}
/**
* Adds a header to the list of sent headers.
*
* @param string $header Header name.
* @param string $value Header value.
*/
public function send_header( $header, $value ) {
$this->sent_headers[ $header ] = $value;
}
/**
* Removes a header from the list of sent headers.
*
* @param string $header Header name.
*/
public function remove_header( $header ) {
unset( $this->sent_headers[ $header ] );
}
/**
* Stores last set status.
*
* @param int $code HTTP status.
*/
public function set_status( $status ) {
$this->status = $status;
}
/**
* Overrides the dispatch method so we can get a handle on the request object.
*
* @param WP_REST_Request $request Request to attempt dispatching.
* @return WP_REST_Response Response returned by the callback.
*/
public function dispatch( $request ) {
$this->last_request = $request;
return parent::dispatch( $request );
}
/**
* Overrides the register_route method so we can re-register routes internally if needed.
*
* @param string $route_namespace Namespace.
* @param string $route The REST route.
* @param array $route_args Route arguments.
* @param bool $override Optional. Whether the route should be overridden if it already exists.
* Default false. Also set `$GLOBALS['wp_rest_server']->override_by_default = true`
* to set overrides when you don't have access to the caller context.
*/
public function register_route( $route_namespace, $route, $route_args, $override = false ) {
parent::register_route( $route_namespace, $route, $route_args, $override || $this->override_by_default );
}
/**
* Serves the request and returns the result.
*
* @param string $path Optional. The request route. If not set, `$_SERVER['PATH_INFO']` will be used.
* Default null.
* @return null|false Null if not served and a HEAD request, false otherwise.
*/
public function serve_request( $path = null ) {
ob_start();
$result = parent::serve_request( $path );
$this->sent_body = ob_get_clean();
return $result;
}
}