class Request (View source)

Constants

HEADER_CLIENT_IP

HEADER_CLIENT_HOST

HEADER_CLIENT_PROTO

HEADER_CLIENT_PORT

Properties

$attributes
$request
$query
$server
$files
$cookies
$headers
protected $content
protected $languages
protected $charsets
protected $acceptableContentTypes
protected $pathInfo
protected $requestUri
protected $baseUrl
protected $basePath
protected $method
protected $format
protected $session
protected $locale
protected $defaultLocale
static protected $formats
static protected $trustProxy
static protected $trustedProxies
static protected $trustedHeaders

Methods

__construct(array $query = [], array $request = [], array $attributes = [], array $cookies = [], array $files = [], array $server = [], string $content = null)

Konstruktor.

initialize(array $query = [], array $request = [], array $attributes = [], array $cookies = [], array $files = [], array $server = [], string $content = null)

Set parameter untuk request saat ini.

static Request
createFromGlobals()

Buat object request baru menggunakan data milik PHP.

static Request
create(string $uri, string $method = 'GET', array $parameters = [], array $cookies = [], array $files = [], array $server = [], string $content = null)

Buat object request baru berdasarkan URI dan konfigurasi yang diberikan.

duplicate(array $query = null, array $request = null, array $attributes = null, array $cookies = null, array $files = null, array $server = null)

Clone object request dan timpa beberapa property-nya.

__clone()

Clone object request saat ini (session tidak akan ikut ter-clone).

string
__toString()

Mereturn object request sebagai string.

overrideGlobals()

Timpa variabel global PHP menurut instance object request saat ini.

static 
setTrustedProxies(array $proxies)

Set list trusted proxy.

static 
setTrustedHeaderName(string $key, string $value)

Set nama trusted header.

static bool
isProxyTrusted()

Periksa apakah isi $_SERVER datang dari trusted proxy atau bukan.

static string
normalizeQueryString(string $queryString)

Normalisasi query string.

mixed
get(string $key, mixed $default = null, bool $deep = false)

Ambil value 'parameter'.

object|null
getSession()

Ambil object session.

bool
hasPreviousSession()

Periksa apakah request saat ini mengandung session yang telah aktif di request - request sebelumnya.

bool
hasSession()

Periksa apakah request saat ini mengandung object session.

setSession(object $session)

Set object session.

string
getClientIp()

Ambil IP klien.

string
getScriptName()

Ambil script name.

string
getPathInfo()

Mereturn path request saat ini. Contoh:.

string
getBasePath()

Mereturn root path request saat ini. Contoh:.

string
getBaseUrl()

Mereturn URL root (tanpa akhiran '/').

string
getScheme()

Ambil skema request (http / https).

string
getPort()

Mereturn port.

string|null
getUser()

Mereturn user pada auth basic PHP.

string|null
getPassword()

Mereturn password pada auth basic PHP.

string
getUserInfo()

Ambil info user dan password pada auth basic PHP.

string
getHttpHost()

Mereturn host untuk request saat ini.

string
getRequestUri()

Mereturn URI.

string
getSchemeAndHttpHost()

Ambil skema dan host.

string
getUri()

Mereturn URI request yang telah dinormalisasi.

string
getUriForPath(string $path)

Mereturn URI ke path yang telah dinormalisasi.

string|null
getQueryString()

Mereturn query string yang telah dinormalisasi.

bool
isSecure()

Periksa apakah request saat ini menggunakan koneksi aman.

string
getHost()

Mereturn hostname.

setMethod(string $method)

Set request method.

string
getMethod()

Ambil request method dalam bentuk uppercase.

string
getMimeType(string $format)

Ambil mime-type berdsarkan format yang diberikan.

string|null
getFormat(string $mimeType)

Ambil format berdsarkan mimetype yang diberikan.

setFormat(string $format, string|array $mimeTypes)

Pasangkan format dengan mime-typenya.

string
getRequestFormat(string $default = 'html')

Ambil format request.

setRequestFormat(string $format)

Set format request.

string|null
getContentType()

Ambil format berdasarkan request.

setDefaultLocale(string $locale)

Set default bahasa.

setLocale(string $locale)

Set bahasa.

string
getLocale()

Ambil bahasa.

bool
isMethod(string $method)

Periksa apakah request method saat ini cocok dengan method yang diberikan.

bool
isMethodSafe()

Periksa apakah request method saat ini aman.

string
getRootUrl()

Ambil URL root aplikasi.

string|resource
getContent(bool $asResource = false)

Mereturn the konten body milik request.

array
getETags()

Ambil ETag.

bool
isNoCache()

Periksa apakah pragma no-cache aktif atau tidak.

string|null
getPreferredLanguage(array $locales = null)

Mereturn preferred language.

array
getLanguages()

Ambil list bahasa yang bisa diterima oleh browser klien.

array
getCharsets()

Ambil list charset yang bisa diterima oleh browser klien.

array
getAcceptableContentTypes()

Ambil list content-type yang bisa diterima oleh browser klien.

bool
isXmlHttpRequest()

Periksa apakah request saat ini menggunakan ajax.

array
splitHttpAcceptHeader(string $header)

Potong - potong header Accept-*.

string
prepareRequestUri()

Siapkan URI request.

string
prepareBaseUrl()

Siapkan base URL.

string
prepareBasePath()

Siapkan base path.

string
preparePathInfo()

Siapkan path info.

static 
initializeFormats()

Inisialisasi format request.

Details

__construct(array $query = [], array $request = [], array $attributes = [], array $cookies = [], array $files = [], array $server = [], string $content = null)

Konstruktor.

Parameters

array $query
array $request
array $attributes
array $cookies
array $files
array $server
string $content

initialize(array $query = [], array $request = [], array $attributes = [], array $cookies = [], array $files = [], array $server = [], string $content = null)

Set parameter untuk request saat ini.

Method ini juga menginisialisasi ulang seluruh property.

Parameters

array $query
array $request
array $attributes
array $cookies
array $files
array $server
string $content

static Request createFromGlobals()

Buat object request baru menggunakan data milik PHP.

Return Value

Request

static Request create(string $uri, string $method = 'GET', array $parameters = [], array $cookies = [], array $files = [], array $server = [], string $content = null)

Buat object request baru berdasarkan URI dan konfigurasi yang diberikan.

Parameters

string $uri
string $method
array $parameters
array $cookies
array $files
array $server
string $content

Return Value

Request

Request duplicate(array $query = null, array $request = null, array $attributes = null, array $cookies = null, array $files = null, array $server = null)

Clone object request dan timpa beberapa property-nya.

Parameters

array $query
array $request
array $attributes
array $cookies
array $files
array $server

Return Value

Request

__clone()

Clone object request saat ini (session tidak akan ikut ter-clone).

string __toString()

Mereturn object request sebagai string.

Return Value

string

overrideGlobals()

Timpa variabel global PHP menurut instance object request saat ini.

Ini akan menimpa value $_GET, $_POST, $_REQUEST, $_SERVER, dan $_COOKIE. Variabel $_FILES tidak akan ditimpa.

static setTrustedProxies(array $proxies)

Set list trusted proxy.

Parameters

array $proxies

static setTrustedHeaderName(string $key, string $value)

Set nama trusted header.

Hanya mendukung header - heder berikut:.


   Request::HEADER_CLIENT_IP:    (default: X-Forwarded-For,   lihat getClientIp())
   Request::HEADER_CLIENT_HOST:  (default: X-Forwarded-Host,  lihat getClientHost())
   Request::HEADER_CLIENT_PORT:  (default: X-Forwarded-Port,  lihat getClientPort())
   Request::HEADER_CLIENT_PROTO: (default: X-Forwarded-Proto, lihat getScheme() dan isSecure())

Mengoper value kosong berarti menonaktifkan trusted header milik key yang diberikan.

Parameters

string $key
string $value

static bool isProxyTrusted()

Periksa apakah isi $_SERVER datang dari trusted proxy atau bukan.

Return Value

bool

static string normalizeQueryString(string $queryString)

Normalisasi query string.

Normalisasi ini akan mengurutkan query string mengikuti alfabet, menghapus delimiter yang tidk diperlukan, serta memberi mekanisme escape yang lebih konsisten.

Parameters

string $queryString

Return Value

string

mixed get(string $key, mixed $default = null, bool $deep = false)

Ambil value 'parameter'.

Method ini sedianya digunakan untuk fleksibilitas saja. Jangan gunakan method ini pada controller anda karena ia sangat lambat.

Urutan: GET, PATH, POST.

Parameters

string $key
mixed $default
bool $deep

Return Value

mixed

object|null getSession()

Ambil object session.

Return Value

object|null

bool hasPreviousSession()

Periksa apakah request saat ini mengandung session yang telah aktif di request - request sebelumnya.

Return Value

bool

bool hasSession()

Periksa apakah request saat ini mengandung object session.

Return Value

bool

setSession(object $session)

Set object session.

Parameters

object $session

string getClientIp()

Ambil IP klien.

Return Value

string

string getScriptName()

Ambil script name.

Return Value

string

string getPathInfo()

Mereturn path request saat ini. Contoh:.


     http://localhost/mysite              mereturn  string kosong
     http://localhost/mysite/about        mereturn  '/about'
     htpp://localhost/mysite/enco%20ded   mereturn  '/enco%20ded'
     http://localhost/mysite/about?var=1  mereturn  '/about'

Return Value

string

string getBasePath()

Mereturn root path request saat ini. Contoh:.


     http://localhost/index.php         mereturn  string kosong
     http://localhost/index.php/page    mereturn  string kosong
     http://localhost/web/index.php     mereturn  '/web'
     http://localhost/we%20b/index.php  mereturn  '/we%20b'

Return Value

string

string getBaseUrl()

Mereturn URL root (tanpa akhiran '/').

Return Value

string

string getScheme()

Ambil skema request (http / https).

Return Value

string

string getPort()

Mereturn port.

Return Value

string

string|null getUser()

Mereturn user pada auth basic PHP.

Return Value

string|null

string|null getPassword()

Mereturn password pada auth basic PHP.

Return Value

string|null

string getUserInfo()

Ambil info user dan password pada auth basic PHP.

Return Value

string

string getHttpHost()

Mereturn host untuk request saat ini.

Juga akan ditambahkan portnya jika tidak menggunakan port standar.

Return Value

string

string getRequestUri()

Mereturn URI.

Return Value

string

string getSchemeAndHttpHost()

Ambil skema dan host.

Return Value

string

string getUri()

Mereturn URI request yang telah dinormalisasi.

Return Value

string

string getUriForPath(string $path)

Mereturn URI ke path yang telah dinormalisasi.

Parameters

string $path

Return Value

string

string|null getQueryString()

Mereturn query string yang telah dinormalisasi.

Return Value

string|null

bool isSecure()

Periksa apakah request saat ini menggunakan koneksi aman.

Return Value

bool

string getHost()

Mereturn hostname.

Return Value

string

setMethod(string $method)

Set request method.

Parameters

string $method

string getMethod()

Ambil request method dalam bentuk uppercase.

Return Value

string

string getMimeType(string $format)

Ambil mime-type berdsarkan format yang diberikan.

Parameters

string $format

Return Value

string

string|null getFormat(string $mimeType)

Ambil format berdsarkan mimetype yang diberikan.

Parameters

string $mimeType

Return Value

string|null

setFormat(string $format, string|array $mimeTypes)

Pasangkan format dengan mime-typenya.

Parameters

string $format
string|array $mimeTypes

string getRequestFormat(string $default = 'html')

Ambil format request.

Parameters

string $default

Return Value

string

setRequestFormat(string $format)

Set format request.

Parameters

string $format

string|null getContentType()

Ambil format berdasarkan request.

Return Value

string|null

setDefaultLocale(string $locale)

Set default bahasa.

Parameters

string $locale

setLocale(string $locale)

Set bahasa.

Parameters

string $locale

string getLocale()

Ambil bahasa.

Return Value

string

bool isMethod(string $method)

Periksa apakah request method saat ini cocok dengan method yang diberikan.

Parameters

string $method

Return Value

bool

bool isMethodSafe()

Periksa apakah request method saat ini aman.

Return Value

bool

string getRootUrl()

Ambil URL root aplikasi.

Return Value

string

string|resource getContent(bool $asResource = false)

Mereturn the konten body milik request.

Parameters

bool $asResource

Return Value

string|resource

array getETags()

Ambil ETag.

Return Value

array

bool isNoCache()

Periksa apakah pragma no-cache aktif atau tidak.

Return Value

bool

string|null getPreferredLanguage(array $locales = null)

Mereturn preferred language.

Parameters

array $locales

Return Value

string|null

array getLanguages()

Ambil list bahasa yang bisa diterima oleh browser klien.

Return Value

array

array getCharsets()

Ambil list charset yang bisa diterima oleh browser klien.

Return Value

array

array getAcceptableContentTypes()

Ambil list content-type yang bisa diterima oleh browser klien.

Return Value

array

bool isXmlHttpRequest()

Periksa apakah request saat ini menggunakan ajax.

Return Value

bool

array splitHttpAcceptHeader(string $header)

Potong - potong header Accept-*.

Parameters

string $header

Return Value

array

protected string prepareRequestUri()

Siapkan URI request.

Return Value

string

protected string prepareBaseUrl()

Siapkan base URL.

Return Value

string

protected string prepareBasePath()

Siapkan base path.

Return Value

string

protected string preparePathInfo()

Siapkan path info.

Return Value

string

static protected initializeFormats()

Inisialisasi format request.