class HTTP (View source)

A class with HTTP-related helpers. Like Debug, this is more a bundle of methods than a class.

Traits

Provides extensions to this object to integrate it with standard config API methods.

Config options

cache_ajax_requests bool
disable_http_cache bool
ignoreDeprecatedCaching bool

Set to true to disable all deprecated HTTP Cache settings

MimeTypes array

Mapping of extension to mime types

cache_control array

List of names to add to the Cache-Control header.

vary string|null

Vary string; A comma separated list of var header names

Properties

protected static deprecated int $cache_age
protected static deprecated int $modification_date
protected static deprecated string $etag

Methods

public static 
config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

public
mixed
stat(string $name) deprecated

Get inherited config value

public
mixed
uninherited(string $name)

Gets the uninherited value for the given config option

public
$this
set_stat(string $name, mixed $value) deprecated

Update the config value for a given property

public static 
string
filename2url(string $filename)

Turns a local system filename into a URL by comparing it to the script filename.

public static 
string
absoluteURLs(string $html)

Turn all relative URLs in the content to absolute URLs.

public static 
string
urlRewriter(string $content, callable $code)

Rewrite all the URLs in the given content, evaluating the given string as PHP code.

public static 
string
setGetVar(string $varname, string $varvalue, string|null $currentURL = null, string $separator = '&')

Will try to include a GET parameter for an existing URL, preserving existing parameters and fragments. If no URL is given, falls back to $_SERVER['REQUEST_URI']. Uses parse_url() to dissect the URL, and http_build_query() to reconstruct it with the additional parameter.

public static 
string
RAW_setGetVar(string $varname, string $varvalue, null|string $currentURL = null)

No description

public static 
array
findByTagAndAttribute(string $content, array $attributes)

Search for all tags with a specific attribute, then return the value of that attribute in a flat array.

public static 
array
getLinksIn(string $content)

No description

public static 
array
getImagesIn(string $content)

No description

public static 
string
get_mime_type(string $filename)

Get the MIME type based on a file's extension. If the finfo class exists in PHP, and the file exists relative to the project root, then use that extension, otherwise fallback to a list of commonly known MIME types.

public static 
set_cache_age(int $age) deprecated

Set the maximum age of this page in web caches, in seconds.

public static 
register_modification_date(string $dateString) deprecated

No description

public static 
register_modification_timestamp(int $timestamp) deprecated

No description

public static 
register_etag(string $etag) deprecated

No description

public static 
add_cache_headers(HTTPResponse $response = null) deprecated

Add the appropriate caching headers to the response, including If-Modified-Since / 304 handling.

public static 
augmentState(HTTPRequest $request, HTTPResponse $response) deprecated

Ensure that all deprecated HTTP cache settings are respected

public static 
string
gmt_date(int $timestamp) deprecated

Return an http://www.faqs.org/rfcs/rfc2822 RFC 2822 date in the GMT timezone (a timestamp is always in GMT: the number of seconds since January 1 1970 00:00:00 GMT)

public static 
int
get_cache_age() deprecated

Return static variable cache_age in second

Details

static Config_ForClass config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

Return Value

Config_ForClass

mixed stat(string $name) deprecated

deprecated 5.0 Use ->config()->get() instead

Get inherited config value

Parameters

string $name

Return Value

mixed

mixed uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

$this set_stat(string $name, mixed $value) deprecated

deprecated 5.0 Use ->config()->set() instead

Update the config value for a given property

Parameters

string $name
mixed $value

Return Value

$this

static string filename2url(string $filename)

Turns a local system filename into a URL by comparing it to the script filename.

Parameters

string $filename

Return Value

string

static string absoluteURLs(string $html)

Turn all relative URLs in the content to absolute URLs.

Parameters

string $html

Return Value

string

static string urlRewriter(string $content, callable $code)

Rewrite all the URLs in the given content, evaluating the given string as PHP code.

Put $URL where you want the URL to appear, however, you can't embed $URL in strings, for example:

  • ```'"../../" . $URL'```
  • ```'myRewriter($URL)'```
  • ```'(substr($URL, 0, 1)=="/") ? "../" . substr($URL, 1) : $URL'```

As of 3.2 $code should be a callable which takes a single parameter and returns the rewritten, for example:

function($url) {
     return Director::absoluteURL($url, true);
}

Parameters

string $content

The HTML to search for links to rewrite.

callable $code

Either a string that can evaluate to an expression to rewrite links (depreciated), or a callable that takes a single parameter and returns the rewritten URL.

Return Value

string

The content with all links rewritten as per the logic specified in $code.

static string setGetVar(string $varname, string $varvalue, string|null $currentURL = null, string $separator = '&')

Will try to include a GET parameter for an existing URL, preserving existing parameters and fragments. If no URL is given, falls back to $_SERVER['REQUEST_URI']. Uses parse_url() to dissect the URL, and http_build_query() to reconstruct it with the additional parameter.

Converts any '&' (ampersand) URL parameter separators to the more XHTML compliant '&'.

CAUTION: If the URL is determined to be relative, it is prepended with Director::absoluteBaseURL(). This method will always return an absolute URL because Director::makeRelative() can lead to inconsistent results.

Parameters

string $varname
string $varvalue
string|null $currentURL

Relative or absolute URL, or HTTPRequest to get url from

string $separator

Separator for http_build_query().

Return Value

string

static string RAW_setGetVar(string $varname, string $varvalue, null|string $currentURL = null)

No description

Parameters

string $varname
string $varvalue
null|string $currentURL

Return Value

string

static array findByTagAndAttribute(string $content, array $attributes)

Search for all tags with a specific attribute, then return the value of that attribute in a flat array.

Parameters

string $content
array $attributes

An array of tags to attributes, for example "[a] => 'href', [div] => 'id'"

Return Value

array

static array getLinksIn(string $content)

No description

Parameters

string $content

Return Value

array

static array getImagesIn(string $content)

No description

Parameters

string $content

Return Value

array

static string get_mime_type(string $filename)

Get the MIME type based on a file's extension. If the finfo class exists in PHP, and the file exists relative to the project root, then use that extension, otherwise fallback to a list of commonly known MIME types.

Parameters

string $filename

Return Value

string

static set_cache_age(int $age) deprecated

deprecated 4.2.0 Use HTTPCacheControlMiddleware::singleton()->setMaxAge($age) instead

Set the maximum age of this page in web caches, in seconds.

Parameters

int $age

static register_modification_date(string $dateString) deprecated

deprecated 4.2.0 Use HTTPCacheControlMiddleware::registerModificationDate() instead

No description

Parameters

string $dateString

static register_modification_timestamp(int $timestamp) deprecated

deprecated 4.2.0 Use HTTPCacheControlMiddleware::registerModificationDate() instead

No description

Parameters

int $timestamp

static register_etag(string $etag) deprecated

deprecated 4.2.0 Use ChangeDetectionMiddleware instead

No description

Parameters

string $etag

static add_cache_headers(HTTPResponse $response = null) deprecated

deprecated 4.2.0 Headers are added automatically by HTTPCacheControlMiddleware instead.

Add the appropriate caching headers to the response, including If-Modified-Since / 304 handling.

Note that setting HTTP::$cache_age will overrule any cache headers set by PHP's session_cache_limiter functionality. It is your responsibility to ensure only cacheable data is in fact cached, and HTTP::$cache_age isn't set when the HTTP body contains session-specific content.

Omitting the $body argument or passing a string is deprecated; in these cases, the headers are output directly.

Parameters

HTTPResponse $response

static augmentState(HTTPRequest $request, HTTPResponse $response) deprecated

deprecated 4.2.0 Use HTTPCacheControlMiddleware instead Simply delete this method in CMS 5 and the calls to it from HTTPCacheControlMiddleware

Ensure that all deprecated HTTP cache settings are respected

Parameters

HTTPRequest $request
HTTPResponse $response

Exceptions

LogicException

static string gmt_date(int $timestamp) deprecated

deprecated 4.2.0 Use native php function gmdate() instead

Return an http://www.faqs.org/rfcs/rfc2822 RFC 2822 date in the GMT timezone (a timestamp is always in GMT: the number of seconds since January 1 1970 00:00:00 GMT)

Parameters

int $timestamp

Return Value

string

static int get_cache_age() deprecated

deprecated 4.13.0 Will be removed without equivalent functionality to replace it

Return static variable cache_age in second

Return Value

int