We are creating a new Phalcon\Http\Message\Request object and a new Phalcon\Http\Message\Uri object with the target URL. Following that we define the method (POST) and additional headers that we need to send with our request. The client then sends the request by using the request object. In the above example, $httpClient is the client of your choice which implements PSR-7.
The above example can be implemented by only using the constructor parameters:
The constructor accepts parameters allowing you to create the object with certain properties populated. You can define the target HTTP method, the URL, the body as well as the headers. All parameters are optional.
It defaults to GET. The supported methods are:
An instance of Phalcon\Http\Message\Uri or a URL.
It defaults to php://memory. The method accepts either an object that implements the StreamInterface or a string such as the name of the stream. The default mode for the stream is w+b. If a non valid stream is passed, an \InvalidArgumentException is thrown
A key value array, with key as the header name and value as the header value.
<?phpusePhalcon\Http\Message\Request;$jwtToken='abc.def.ghi';$request=newRequest('POST','https://api.phalconphp.com/companies/1','php://memory',['Authorization'=>'Bearer '.$jwtToken,'Content-Type'=>'application/json',]);echo$request->getMethod();// POST
Returns all the message header values. The keys represent the header name as it will be sent over the wire, and each value is an array of strings associated with the header. While header names are not case-sensitive, this method preserves the exact case in which headers were originally specified.
Retrieves the message’s request-target either as it will appear (for clients), as it appeared at request (for servers), or as it was specified for the instance (see withRequestTarget()). In most cases, this will be the origin-form of the composed URI, unless a value was provided to the concrete implementation (see withRequestTarget()).
Returns an instance with the specified header appended with the given value. Existing values for the specified header will be maintained. The new value(s) will be appended to the existing list. If the header did not exist previously, it will be added. Throws \InvalidArgumentException for invalid header names or values.
Returns an instance with the provided value replacing the specified header. While header names are case-insensitive, the casing of the header will be preserved by this function, and returned from getHeaders(). Throws \InvalidArgumentException for invalid header names or values.
Return an instance with the provided HTTP method. Throws \InvalidArgumentException for invalid HTTP methods.
<?phpusePhalcon\Http\Message\Request;$jwtToken='abc.def.ghi';$request=newRequest('POST','https://api.phalconphp.com/companies/1','php://memory',['Authorization'=>'Bearer '.$jwtToken,'Content-Type'=>'application/json',]);echo$request->getMethod();// POST$clone=$request->withMethod('GET');echo$clone->getMethod();// GET
Returns an instance with the provided URI. This method updates the Host header of the returned request by default if the URI contains a host component. If the URI does not contain a host component, any pre-existing Host header will be carried over to the returned request.
You can opt-in to preserving the original state of the Host header by setting $preserveHost to true. When $preserveHost is set to true, this method interacts with the Host header in the following ways:
If the Host header is missing or empty, and the new URI contains a host component, this method MUST update the Host header in the returned request.
If the Host header is missing or empty, and the new URI does not contain a host component, this method MUST NOT update the Host header in the returned request.
If a Host header is present and non-empty, this method will not update the Host header in the returned request.