RequestInterface.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Rest;
 
use Psr\Http\Message\StreamInterface;
use Psr\Http\Message\UriInterface;
 
interface RequestInterface {
    public const NO_BODY_METHODS = [ 'GET', 'HEAD' ];
 
    public const BODY_METHODS = [ 'POST', 'PUT' ];
 
    // NOTE: per RFC 7231 (https://www.rfc-editor.org/rfc/rfc7231#section-4.3.5), sending a body
    // with the DELETE method "has no defined semantics". We allow it, as it is useful for
    // passing the csrf token required by some authentication methods.
 
    public const JSON_CONTENT_TYPE = 'application/json';
    public const MULTIPART_FORM_DATA_CONTENT_TYPE = 'multipart/form-data';
    public const FORM_URLENCODED_CONTENT_TYPE = 'application/x-www-form-urlencoded';
 
    public const FORM_DATA_CONTENT_TYPES = [
        self::FORM_URLENCODED_CONTENT_TYPE,
        self::MULTIPART_FORM_DATA_CONTENT_TYPE,
    ];
 
    public function getMethod();
 
    public function getUri();
 
    // MessageInterface
 
    public function getProtocolVersion();
 
    public function getHeaders();
 
    public function getHeader( $name );
 
    public function hasHeader( $name );
 
    public function getHeaderLine( $name );
 
    public function getBody();
 
    // ServerRequestInterface
 
    public function getServerParams();
 
    public function getCookieParams();
 
    public function getQueryParams();
 
    public function getUploadedFiles();
 
    // MediaWiki extensions to PSR-7
 
    public function getPathParams();
 
    public function getPathParam( $name );
 
    public function setPathParams( $params );
 
    public function getCookiePrefix();
 
    public function getCookie( $name, $default = null );
 
    public function getPostParams();
 
    public function getParsedBody(): ?array;
 
    public function setParsedBody( ?array $data );
 
    public function getBodyType(): ?string;
 
    public function hasBody(): bool;
}