Thijs/wiki.techinc.nl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Document OutputPage::addVaryHeader()

Browse source 
The $options parameter to OutputPage::addVaryHeader() is undocumented as
to what exactly is supposed to be passed to it. Fix that.

Change-Id: I5fcbb8cf6219c6ab001962a4c2170e1733732426
This commit is contained in:
Brad Jorsch 2015-09-04 12:59:20 -04:00
parent 77837c039d
commit 242ca95565
1 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
includes/OutputPage.php
View file

@ -2012,9 +2012,11 @@ class OutputPage extends ContextSource {
* Add an HTTP header that will influence on the cache
*
* @param string $header Header name
* @param array|null $option
* @todo FIXME: Document the $option parameter; it appears to be for
* X-Vary-Options but what format is acceptable?
* @param string[]|null $option Options for X-Vary-Options. Possible options are:
* - "string-contains=$XXX" varies on whether the header value as a string
* contains $XXX as a substring.
* - "list-contains=$XXX" varies on whether the header value as a
* comma-separated list contains $XXX as one of the list items.
*/
public function addVaryHeader( $header, $option = null ) {
if ( !array_key_exists( $header, $this->mVaryHeader ) ) {