Index | Nette Http API

A

IResponse::addHeader() — Method in class IResponse: Adds HTTP header.
$ Request#ajax — Property in class Request
Response::addHeader() — Method in class Response: Adds HTTP header.
Session::autoStart() — Method in class Session
$ Url#absoluteUrl — Property in class Url
$ Url#authority — Property in class Url
Url::appendQuery() — Method in class Url
$ UrlImmutable#absoluteUrl — Property in class UrlImmutable
$ UrlImmutable#authority — Property in class UrlImmutable

B

$ Url#basePath — Property in class Url
$ Url#baseUrl — Property in class Url
$ UrlScript#basePath — Property in class UrlScript
$ UrlScript#baseUrl — Property in class UrlScript

C

Context — Class in namespace Nette\Http: HTTP-specific tasks.
$ FileUpload#contentType — Property in class FileUpload
$ FileUpload#contents — Property in class FileUpload
$ Request#cookies — Property in class Request
RequestFactory::createHttpRequest() — Method in class RequestFactory
$ Response#cookieDomain — Property in class Response: The domain in which the cookie will be available
$ Response#cookiePath — Property in class Response: The path in which the cookie will be available
$ Response#cookieSecure — Property in class Response: Whether the cookie is available only through HTTPS
Session::close() — Method in class Session: Ends the current session and store session data.
Url::canonicalize() — Method in class Url: Transforms URL to canonical form.

D

IResponse::deleteCookie() — Method in class IResponse: Deletes a cookie.
IResponse::deleteHeader() — Method in class IResponse
Request::detectLanguage() — Method in class Request: Returns the most preferred language by browser. Uses the Accept-Language header. If no match is reached, it returns null.
Response::deleteHeader() — Method in class Response
Response::deleteCookie() — Method in class Response: Deletes a cookie.
Session::destroy() — Method in class Session: Destroys all data registered to a session.
$ Url#defaultPorts — Property in class Url

E

$ FileUpload#error — Property in class FileUpload
Session::exists() — Method in class Session: Does session exist for the current request?
Url::export() — Method in class Url
UrlImmutable::export() — Method in class UrlImmutable

F

FileUpload — Class in namespace Nette\Http: Provides access to individual files that have been uploaded by a client.
Helpers::formatDate() — Method in class Helpers: Returns HTTP valid date format.
$ Request#files — Property in class Request
RequestFactory::fromGlobals() — Method in class RequestFactory: Returns new Request instance, using values from superglobals.
$ Url#fragment — Property in class Url
$ UrlImmutable#fragment — Property in class UrlImmutable

G

HttpExtension::getConfigSchema() — Method in class HttpExtension
SessionExtension::getConfigSchema() — Method in class SessionExtension
SessionPanel::getTab() — Method in class SessionPanel: Renders tab.
SessionPanel::getPanel() — Method in class SessionPanel: Renders panel.
Context::getRequest() — Method in class Context
Context::getResponse() — Method in class Context
FileUpload::getName() — Method in class FileUpload
FileUpload::getUntrustedName() — Method in class FileUpload: Returns the original file name as submitted by the browser. Do not trust the value returned by this method.
FileUpload::getSanitizedName() — Method in class FileUpload: Returns the sanitized file name. The resulting name contains only ASCII characters [a-zA-Z0-9.-].
FileUpload::getUntrustedFullPath() — Method in class FileUpload: Returns the original full path as submitted by the browser during directory upload. Do not trust the value returned by this method. A client could send a malicious directory structure with the intention to corrupt or hack your application.
FileUpload::getContentType() — Method in class FileUpload: Detects the MIME content type of the uploaded file based on its signature. Requires PHP extension fileinfo.
FileUpload::getSuggestedExtension() — Method in class FileUpload: Returns the appropriate file extension (without the period) corresponding to the detected MIME type. Requires the PHP extension fileinfo.
FileUpload::getSize() — Method in class FileUpload: Returns the size of the uploaded file in bytes.
FileUpload::getTemporaryFile() — Method in class FileUpload: Returns the path of the temporary location of the uploaded file.
FileUpload::getError() — Method in class FileUpload: Returns the error code. It has to be one of UPLOAD_ERR_XXX constants.
FileUpload::getImageSize() — Method in class FileUpload: Returns a pair of [width, height] with dimensions of the uploaded image.
FileUpload::getImageFileExtension() — Method in class FileUpload: Returns image file extension based on detected content type (without dot).
FileUpload::getContents() — Method in class FileUpload: Returns the contents of the uploaded file. If the upload was not successful, it returns null.
IRequest::getUrl() — Method in class IRequest: Returns URL object.
IRequest::getQuery() — Method in class IRequest: Returns variable provided to the script via URL query ($_GET).
IRequest::getPost() — Method in class IRequest: Returns variable provided to the script via POST method ($_POST).
IRequest::getFile() — Method in class IRequest: Returns uploaded file.
IRequest::getFiles() — Method in class IRequest: Returns uploaded files.
IRequest::getCookie() — Method in class IRequest: Returns variable provided to the script via HTTP cookies.
IRequest::getCookies() — Method in class IRequest: Returns variables provided to the script via HTTP cookies.
IRequest::getMethod() — Method in class IRequest: Returns HTTP request method (GET, POST, HEAD, PUT, ...). The method is case-sensitive.
IRequest::getHeader() — Method in class IRequest: Return the value of the HTTP header. Pass the header name as the plain, HTTP-specified header name (e.g. 'Accept-Encoding').
IRequest::getHeaders() — Method in class IRequest: Returns all HTTP headers.
IRequest::getRemoteAddress() — Method in class IRequest: Returns the IP address of the remote client.
IRequest::getRemoteHost() — Method in class IRequest: Returns the host of the remote client.
IRequest::getRawBody() — Method in class IRequest: Returns raw content of HTTP request body.
IRequest::getReferer() — Method in class IRequest: Returns referrer.
IResponse::getCode() — Method in class IResponse: Returns HTTP response code.
IResponse::getHeader() — Method in class IResponse: Returns value of an HTTP header.
IResponse::getHeaders() — Method in class IResponse: Returns an associative array of headers to sent.
Request::getUrl() — Method in class Request: Returns the URL of the request.
Request::getQuery() — Method in class Request: Returns variable provided to the script via URL query ($_GET).
Request::getPost() — Method in class Request: Returns variable provided to the script via POST method ($_POST).
Request::getFile() — Method in class Request: Returns uploaded file.
Request::getFiles() — Method in class Request: Returns tree of upload files in a normalized structure, with each leaf an instance of Nette\Http\FileUpload.
Request::getCookie() — Method in class Request: Returns a cookie or null if it does not exist.
Request::getCookies() — Method in class Request: Returns all cookies.
Request::getMethod() — Method in class Request: Returns the HTTP method with which the request was made (GET, POST, HEAD, PUT, ...).
Request::getHeader() — Method in class Request: Returns an HTTP header or null if it does not exist. The parameter is case-insensitive.
Request::getHeaders() — Method in class Request: Returns all HTTP headers as associative array.
Request::getReferer() — Method in class Request: Returns referrer.
Request::getOrigin() — Method in class Request: What origin did the user come from? It contains scheme, hostname and port.
Request::getRemoteAddress() — Method in class Request: Returns the IP address of the remote client.
Request::getRemoteHost() — Method in class Request: Returns the host of the remote client.
Request::getRawBody() — Method in class Request: Returns raw content of HTTP request body.
Request::getDecodedBody() — Method in class Request: Returns decoded content of HTTP request body.
Request::getBasicCredentials() — Method in class Request: Returns basic HTTP authentication credentials.
Response::getCode() — Method in class Response: Returns HTTP response code.
Response::getHeader() — Method in class Response: Returns value of an HTTP header.
Response::getHeaders() — Method in class Response: Returns an associative array of headers to sent.
Session::getId() — Method in class Session: Returns the current session ID. Don't make dependencies, can be changed for each request.
Session::getName() — Method in class Session: Gets the session name.
Session::getSection() — Method in class Session: Returns specified session section.
Session::getSectionNames() — Method in class Session
Session::getOptions() — Method in class Session: Returns all session options.
SessionSection::getIterator() — Method in class SessionSection: Returns an iterator over all section variables.
SessionSection::get() — Method in class SessionSection: Gets a variable from this session section.
Url::getScheme() — Method in class Url
Url::getUser() — Method in class Url
Url::getPassword() — Method in class Url
Url::getHost() — Method in class Url
Url::getDomain() — Method in class Url: Returns the part of domain.
Url::getPort() — Method in class Url
Url::getDefaultPort() — Method in class Url
Url::getPath() — Method in class Url
Url::getQuery() — Method in class Url
Url::getQueryParameters() — Method in class Url
Url::getQueryParameter() — Method in class Url
Url::getFragment() — Method in class Url
Url::getAbsoluteUrl() — Method in class Url
Url::getAuthority() — Method in class Url: Returns the [user[:pass]@]host[:port] part of URI.
Url::getHostUrl() — Method in class Url: Returns the scheme and authority part of URI.
Url::getBasePath() — Method in class Url
Url::getBaseUrl() — Method in class Url
Url::getRelativeUrl() — Method in class Url
UrlImmutable::getScheme() — Method in class UrlImmutable
UrlImmutable::getUser() — Method in class UrlImmutable
UrlImmutable::getPassword() — Method in class UrlImmutable
UrlImmutable::getHost() — Method in class UrlImmutable
UrlImmutable::getDomain() — Method in class UrlImmutable
UrlImmutable::getPort() — Method in class UrlImmutable
UrlImmutable::getDefaultPort() — Method in class UrlImmutable
UrlImmutable::getPath() — Method in class UrlImmutable
UrlImmutable::getQuery() — Method in class UrlImmutable
UrlImmutable::getQueryParameters() — Method in class UrlImmutable
UrlImmutable::getQueryParameter() — Method in class UrlImmutable
UrlImmutable::getFragment() — Method in class UrlImmutable
UrlImmutable::getAbsoluteUrl() — Method in class UrlImmutable: Returns the entire URI including query string and fragment.
UrlImmutable::getAuthority() — Method in class UrlImmutable: Returns the [user[:pass]@]host[:port] part of URI.
UrlImmutable::getHostUrl() — Method in class UrlImmutable: Returns the scheme and authority part of URI.
UrlScript::getScriptPath() — Method in class UrlScript
UrlScript::getBasePath() — Method in class UrlScript
UrlScript::getRelativePath() — Method in class UrlScript
UrlScript::getBaseUrl() — Method in class UrlScript
UrlScript::getRelativeUrl() — Method in class UrlScript
UrlScript::getPathInfo() — Method in class UrlScript: Returns the additional path information.

H

HttpExtension — Class in namespace Nette\Bridges\HttpDI: HTTP extension for Nette DI.
FileUpload::hasFile() — Method in class FileUpload: Returns true if the user has uploaded a file.
Helpers — Class in namespace Nette\Http: Rendering helpers for HTTP.
$ Request#headers — Property in class Request
$ Response#headers — Property in class Response
Session::hasSection() — Method in class Session: Checks if a session section exist and is not empty.
$ Url#host — Property in class Url
$ Url#hostUrl — Property in class Url
$ UrlImmutable#host — Property in class UrlImmutable
$ UrlImmutable#hostUrl — Property in class UrlImmutable

I

Context::isModified() — Method in class Context: Attempts to cache the sent entity by its last modification date.
FileUpload::isOk() — Method in class FileUpload: Returns true if the file was uploaded successfully.
FileUpload::isImage() — Method in class FileUpload: Returns true if the uploaded file is an image and the format is supported by PHP, so it can be loaded using the toImage() method.
Helpers::ipMatch() — Method in class Helpers: Is IP address in CIDR block?
Helpers::initCookie() — Method in class Helpers
IRequest — Class in namespace Nette\Http: HTTP request provides access scheme for request sent via HTTP.
IRequest::isMethod() — Method in class IRequest: Checks HTTP request method.
IRequest::isSecured() — Method in class IRequest: Is the request sent via secure channel (https)?
IRequest::isAjax() — Method in class IRequest: Is AJAX request?
IRequest::isSameSite() — Method in class IRequest: Is the request sent from the same origin?
IResponse — Class in namespace Nette\Http: HTTP response interface.
IResponse::isSent() — Method in class IResponse: Checks if headers have been sent.
Request::isMethod() — Method in class Request: Checks the HTTP method with which the request was made. The parameter is case-insensitive.
Request::isSecured() — Method in class Request: Is the request sent via secure channel (https)?
Request::isSameSite() — Method in class Request: Is the request coming from the same site and is initiated by clicking on a link?
Request::isAjax() — Method in class Request: Is it an AJAX request?
Response::isSent() — Method in class Response: Checks if headers have been sent.
Session::isStarted() — Method in class Session: Has been session started?
Url::isEqual() — Method in class Url: URL comparison.
Url::isAbsolute() — Method in class Url: Determines if URL is absolute, ie if it starts with a scheme followed by colon.
UrlImmutable::isEqual() — Method in class UrlImmutable

J

Url::jsonSerialize() — Method in class Url
UrlImmutable::jsonSerialize() — Method in class UrlImmutable

L

HttpExtension::loadConfiguration() — Method in class HttpExtension
SessionExtension::loadConfiguration() — Method in class SessionExtension

M

FileUpload::move() — Method in class FileUpload: Moves an uploaded file to a new location. If the destination file already exists, it will be overwritten.
$ Request#method — Property in class Request
UrlImmutable::mergePath() — Method in class UrlImmutable
UrlScript::mergePath() — Method in class UrlScript

N

$ FileUpload#name — Property in class FileUpload

O

$ FileUpload#ok — Property in class FileUpload
$ Session#onStart — Property in class Session
$ Session#onBeforeWrite — Property in class Session
SessionSection::offsetSet() — Method in class SessionSection
SessionSection::offsetGet() — Method in class SessionSection
SessionSection::offsetExists() — Method in class SessionSection
SessionSection::offsetUnset() — Method in class SessionSection

P

$ Request#post — Property in class Request
$ Url#password — Property in class Url
$ Url#port — Property in class Url
$ Url#path — Property in class Url
Url::parseQuery() — Method in class Url: Parses query string. Is affected by directive arg_separator.input.
$ UrlImmutable#password — Property in class UrlImmutable
$ UrlImmutable#port — Property in class UrlImmutable
$ UrlImmutable#path — Property in class UrlImmutable
$ UrlScript#pathInfo — Property in class UrlScript

Q

$ Request#query — Property in class Request
$ Url#query — Property in class Url
$ Url#queryParameters — Property in class Url
$ UrlImmutable#query — Property in class UrlImmutable
$ UrlImmutable#queryParameters — Property in class UrlImmutable

R

IResponse::redirect() — Method in class IResponse: Redirects to a new URL.
Request — Class in namespace Nette\Http: HttpRequest provides access scheme for request sent via HTTP.
$ Request#referer — Property in class Request
$ Request#remoteAddress — Property in class Request
$ Request#remoteHost — Property in class Request
$ Request#rawBody — Property in class Request
RequestFactory — Class in namespace Nette\Http: HTTP request factory.
Response — Class in namespace Nette\Http: HttpResponse class.
Response::redirect() — Method in class Response: Redirects to a new URL.
Session::regenerateId() — Method in class Session: Regenerates the session ID.
SessionSection::remove() — Method in class SessionSection: Removes a variable or whole section.
SessionSection::removeExpiration() — Method in class SessionSection: Removes the expiration from the section or specific variables.
$ Url#relativeUrl — Property in class Url
Url::removeDotSegments() — Method in class Url: Normalizes a path by handling and removing relative path references like '.', '..' and directory traversal.
UrlImmutable::resolve() — Method in class UrlImmutable: Resolves relative URLs in the same way as browser. If path is relative, it is resolved against base URL, if begins with /, it is resolved against the host root.
$ UrlScript#relativePath — Property in class UrlScript
$ UrlScript#relativeUrl — Property in class UrlScript

S

SessionExtension — Class in namespace Nette\Bridges\HttpDI: Session extension for Nette DI.
SessionPanel — Class in namespace Nette\Bridges\HttpTracy: Session panel for Debugger Bar.
$ FileUpload#sanitizedName — Property in class FileUpload
$ FileUpload#size — Property in class FileUpload
IResponse::setCode() — Method in class IResponse: Sets HTTP response code.
IResponse::setHeader() — Method in class IResponse: Sends a HTTP header and replaces a previous one.
IResponse::setContentType() — Method in class IResponse: Sends a Content-type HTTP header.
IResponse::setExpiration() — Method in class IResponse: Sets the time (like '20 minutes') before a page cached on a browser expires, null means "must-revalidate".
IResponse::setCookie() — Method in class IResponse: Sends a cookie.
$ Request#secured — Property in class Request
RequestFactory::setBinary() — Method in class RequestFactory
RequestFactory::setProxy() — Method in class RequestFactory
Response::setCode() — Method in class Response: Sets HTTP response code.
Response::setHeader() — Method in class Response: Sends a HTTP header and replaces a previous one.
Response::setContentType() — Method in class Response: Sends a Content-type HTTP header.
Response::sendAsFile() — Method in class Response: Response should be downloaded with 'Save as' dialog.
Response::setExpiration() — Method in class Response: Sets the time (like '20 minutes') before a page cached on a browser expires, null means "must-revalidate".
Response::setCookie() — Method in class Response: Sends a cookie.
Session — Class in namespace Nette\Http: Provides access to session sections as well as session settings and management methods.
Session::start() — Method in class Session: Starts and initializes session data.
Session::setName() — Method in class Session: Sets the session name to a specified one.
Session::setOptions() — Method in class Session: Sets session options.
Session::setExpiration() — Method in class Session: Sets the amount of time (like '20 minutes') allowed between requests before the session will be terminated, null means "for a maximum of 3 hours or until the browser is closed".
Session::setCookieParameters() — Method in class Session: Sets the session cookie parameters.
Session::setSavePath() — Method in class Session: Sets path of the directory used to save session data.
Session::setHandler() — Method in class Session: Sets user session handler.
SessionSection — Class in namespace Nette\Http: Session section.
SessionSection::set() — Method in class SessionSection: Sets a variable in this session section.
SessionSection::setExpiration() — Method in class SessionSection: Sets the expiration of the section or specific variables.
$ Url#scheme — Property in class Url
Url::setScheme() — Method in class Url
Url::setUser() — Method in class Url
Url::setPassword() — Method in class Url
Url::setHost() — Method in class Url
Url::setPort() — Method in class Url
Url::setPath() — Method in class Url
Url::setQuery() — Method in class Url
Url::setQueryParameter() — Method in class Url
Url::setFragment() — Method in class Url
$ UrlImmutable#scheme — Property in class UrlImmutable
$ UrlScript#scriptPath — Property in class UrlScript

T

$ FileUpload#temporaryFile — Property in class FileUpload
FileUpload::toImage() — Method in class FileUpload: Converts uploaded image to Nette\Utils\Image object.

U

$ FileUpload#untrustedFullPath — Property in class FileUpload
$ Request#url — Property in class Request
$ RequestFactory#urlFilters — Property in class RequestFactory
Url — Class in namespace Nette\Http: Mutable representation of a URL.
$ Url#user — Property in class Url
Url::unescape() — Method in class Url: Similar to rawurldecode, but preserves reserved chars encoded.
UrlImmutable — Class in namespace Nette\Http: Immutable representation of a URL.
$ UrlImmutable#user — Property in class UrlImmutable
UrlScript — Class in namespace Nette\Http: Immutable representation of a URL with application base-path.

W

Request::withUrl() — Method in class Request: Returns a clone with a different URL.
$ Response#warnOnBuffer — Property in class Response: Whether warn on possible problem with data in output buffer
UrlImmutable::withScheme() — Method in class UrlImmutable
UrlImmutable::withUser() — Method in class UrlImmutable
UrlImmutable::withPassword() — Method in class UrlImmutable
UrlImmutable::withoutUserInfo() — Method in class UrlImmutable
UrlImmutable::withHost() — Method in class UrlImmutable
UrlImmutable::withPort() — Method in class UrlImmutable
UrlImmutable::withPath() — Method in class UrlImmutable
UrlImmutable::withQuery() — Method in class UrlImmutable
UrlImmutable::withQueryParameter() — Method in class UrlImmutable
UrlImmutable::withFragment() — Method in class UrlImmutable
UrlScript::withPath() — Method in class UrlScript

_

HttpExtension::__construct() — Method in class HttpExtension
SessionExtension::__construct() — Method in class SessionExtension
Context::__construct() — Method in class Context
FileUpload::__construct() — Method in class FileUpload
FileUpload::__toString() — Method in class FileUpload: Returns the path of the temporary location of the uploaded file.
Request::__construct() — Method in class Request
Response::__construct() — Method in class Response
Session::__construct() — Method in class Session
Session::__destruct() — Method in class Session
SessionSection::__construct() — Method in class SessionSection: Do not call directly. Use Session::getSection().
SessionSection::__set() — Method in class SessionSection
SessionSection::__get() — Method in class SessionSection
SessionSection::__isset() — Method in class SessionSection
SessionSection::__unset() — Method in class SessionSection
Url::__construct() — Method in class Url
Url::__toString() — Method in class Url
UrlImmutable::__construct() — Method in class UrlImmutable
UrlImmutable::__toString() — Method in class UrlImmutable
UrlScript::__construct() — Method in class UrlScript