• Home
• SimpleSAML
• Utils
• HTTP

PHP Class SimpleSAML\Utils\HTTP

Show file Open project: simplesamlphp/simplesamlphp Class Usage Examples

Public Methods

Method	Description
addURLParameters ( string $url, array $parameters ) : string	Add one or more query parameters to the given URL.
checkSessionCookie ( string | null $retryURL = null ) : void	Check for session cookie, and show missing-cookie page if it is missing.
checkURLAllowed ( string $url, array $trustedSites = null ) : string	Check if a URL is valid and is in our list of allowed URLs.
fetch ( string $url, array $context = [], boolean $getHeaders = false ) : mixed	Helper function to retrieve a file or URL with proxy support, also supporting proxy basic authorization.
getAcceptLanguage ( ) : array	This function parses the Accept-Language HTTP header and returns an associative array with each language and the score for that language. If a language includes a region, then the result will include both the language with the region and the language without the region.
getBaseURL ( ) : string	Retrieve the base URL of the SimpleSAMLphp installation. The URL will always end with a '/'. For example: https://idp.example.org/simplesaml/
getFirstPathElement ( boolean $trailingslash = true ) : string	Retrieve the first element of the URL path.
getPOSTRedirectURL ( string $destination, array $data ) : string	Create a link which will POST data.
getSelfHost ( ) : string	Retrieve our own host.
getSelfHostWithNonStandardPort ( ) : string	Retrieve our own host, including the port in case the it is not standard for the protocol in use. That is port 80 for HTTP and port 443 for HTTPS.
getSelfHostWithPath ( ) : string	Retrieve our own host together with the URL path. Please note this function will return the base URL for the current SP, as defined in the global configuration.
getSelfURL ( ) : string	Retrieve the current URL using the base URL in the configuration, if possible.
getSelfURLHost ( ) : string	Retrieve the current URL using the base URL in the configuration, containing the protocol, the host and optionally, the port number.
getSelfURLNoQuery ( ) : string	Retrieve the current URL using the base URL in the configuration, without the query parameters.
guessBasePath ( ) : string	Try to guess the base SimpleSAMLphp path from the current request.
isHTTPS ( ) : boolean	This function checks if we are using HTTPS as protocol.
normalizeURL ( string $url ) : string	Normalizes a URL to an absolute URL and validate it. In addition to resolving the URL, this function makes sure that it is a link to an http or https site.
parseQueryString ( string $query_string ) : array	Parse a query string into an array.
redirectTrustedURL ( string $url, string[] $parameters = [] ) : void	This function redirects to the specified URL without performing any security checks. Please, do NOT use this function with user supplied URLs.
redirectUntrustedURL ( string $url, string[] $parameters = [] ) : void	This function redirects to the specified URL after performing the appropriate security checks on it.
resolveURL ( string $url, string $base = null ) : string	Resolve a (possibly relative) URL relative to a given base URL.
setCookie ( string $name, string | null $value, array | null $params = null, boolean $throw = true )	Set a cookie.
submitPOSTData ( string $destination, array $data )	Submit a POST form to a specific destination.

Private Methods

Method	Description
getSecurePOSTRedirectURL ( string $destination, array $data ) : string	Obtain a URL where we can redirect to securely post a form with the given data to a specific destination.
getServerHTTPS ( ) : boolean	Retrieve HTTPS status from $_SERVER environment variables.
getServerHost ( ) : string	Retrieve Host value from $_SERVER environment variables.
getServerPort ( ) : string	Retrieve the port number from $_SERVER environment variables.
redirect ( string $url, string[] $parameters = [] ) : void	This function redirects the user to the specified address.
savePOSTData ( SimpleSAML_Session $session, string $destination, array $data ) : string	Save the given HTTP POST data and the destination where it should be posted to a given session.

Method Details