Skip to content

Request Instance ​

WeeSpeed encapsulates request-related methods using the Request class. For ease of use, you can use the request() function to obtain a request instance. For example:

php
$request = request();
$name = $request->get('name');
$file = request()->file('logo');

Request Methods ​

The Request class encapsulates the following methods:

get($name, $default = null) ​

Get query parameters, that is, retrieve parameters from $_GET .

    Parameters: $name: Parameter name
       $default: Default value

Return value: The submitted parameter value or the default value. Returns null if no value is submitted and no default value is provided.

post($name, $default = null) ​

Get POST parameters, that is, retrieve parameters from $_POST .

    Parameters: $name: Parameter name
       $default: Default value

Return value: The submitted parameter value or the default value. Returns null if no value is submitted and no default value is provided.

file($name) ​

Get uploaded files, that is, retrieve parameters from $_FILE .

   Parameters: $name: Parameter name

Return value: The uploaded file object, or null if no file is submitted.

header($name, $default = null) ​

Get the parameters submitted in the header.

  Parameters:
       - $name: Parameter name
       - $default: Default value

Return value: The submitted parameter value or the default value. Returns null if no value is submitted and no default value is provided.

server($name, $default = null) ​

Get server parameters, i.e., retrieve parameters from $_SERVER.

  Parameters:
       - $name: Parameter name
       - $default: Default value

Return value: The submitted parameter value or the default value. Returns null if no value is submitted and no default value is provided.

rawBody() ​

Get the raw POST request body. This is useful when retrieving POST request data in a non-application/x-www-form-urlencoded format.

Return value: The request body.

data($name, $value) ​

Add data to the request object for passing parameters for the same request among controllers, middleware, or other methods.

  Parameters:
       - $name: Parameter name
       - $value: Default value

Return value: No return value.

data($name) ​

Read data with the specified name from the request object.

  Parameters:
       - $name: Parameter name

Return value: The variable value. Returns null if no value exists.

Helper Methods ​

getRealIp() ​

Get the client's real IP address.

Return value: A string representing the IP address.

isAjax() ​

Determine whether the request is an Ajax request.

Return value: true or false.

Tip

The methods of the request instance are already encapsulated in the base controller class. You can use $this-> to execute these methods in the controller.