PHPXRef 0.7.1 : MediaWiki-1.24.0 : Detail view of SquidUpdate.php

[Source view] [Print] [Project Stats]

Squid cache purging. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

File Size:	311 lines (9 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

SquidUpdate:: (9 methods):
  __construct()
  newFromLinksTo()
  newFromTitles()
  newSimplePurge()
  doUpdate()
  purge()
  HTCPPurge()
  expand()
  getRuleForURL()

Class: SquidUpdate - X-Ref

Handles purging appropriate Squid URLs given a title (or titles)

__construct( $urlArr = array() X-Ref

param: array $urlArr Collection of URLs to purge
param: bool|int $maxTitles Maximum number of unique URLs to purge

newFromLinksTo( Title $title ) X-Ref

Create a SquidUpdate from the given Title object.

The resulting SquidUpdate will purge the given Title's URLs as well as
the pages that link to it. Capped at $wgMaxSquidPurgeTitles total URLs.

param: Title $title
return: SquidUpdate

newFromTitles( $titles, $urlArr = array() X-Ref

Create a SquidUpdate from an array of Title objects, or a TitleArray object

param: array $titles
param: array $urlArr
return: SquidUpdate

newSimplePurge( Title $title ) X-Ref

param: Title $title
return: SquidUpdate

doUpdate() X-Ref

Purges the list of URLs passed to the constructor.

purge( $urlArr ) X-Ref

Purges a list of Squids defined in $wgSquidServers.
$urlArr should contain the full URLs to purge as values
(example: $urlArr[] = 'http://my.host/something')
XXX report broken Squids per mail or log

param: array $urlArr List of full URLs to purge

HTCPPurge( $urlArr ) X-Ref

Send Hyper Text Caching Protocol (HTCP) CLR requests.

param: array $urlArr Collection of URLs to purge

expand( $url ) X-Ref

Expand local URLs to fully-qualified URLs using the internal protocol
and host defined in $wgInternalServer. Input that's already fully-
qualified will be passed through unchanged.

This is used to generate purge URLs that may be either local to the
main wiki or include a non-native host, such as images hosted on a
second internal server.

Client functions should not need to call this.

param: string $url
return: string

getRuleForURL( $url, $rules ) X-Ref

Find the HTCP routing rule to use for a given URL.

param: string $url URL to match
param: array $rules Array of rules, see $wgHTCPRouting for format and behavior
return: mixed Element of $rules that matched, or false if nothing matched

PHP Cross Reference of MediaWiki-1.24.0

/includes/deferred/ -> SquidUpdate.php (summary)

Defines 1 class