GenerateSitemap Class Reference

Maintenance script that generates a sitemap for the site. More...

Inherits Maintenance.

Collaboration diagram for GenerateSitemap:

Public Member Functions
	__construct ()
	Default constructor.
	execute ()
	Execute.
	main ()
	Main loop.
Public Member Functions inherited from Maintenance
	canExecuteWithoutLocalSettings ()
	Whether this script can run without LocalSettings.php.
	checkRequiredExtensions ()
	Verify that the required extensions are installed.
	cleanupChanneled ()
	Clean up channeled output.
	clearParamsAndArgs ()
	Clear all params and arguments.
	finalSetup (SettingsBuilder $settingsBuilder=null)
	Handle some last-minute setup here.
	getConfig ()
	getDbType ()
	Does the script need different DB access? By default, we give Maintenance scripts normal rights to the DB.
	getName ()
	Get the script's name.
	getParameters ()
	globals ()
	Potentially debug globals.
	isQuiet ()
	loadParamsAndArgs ( $self=null, $opts=null, $args=null)
	Process command line arguments when running as a child script.
	loadSettings ()
	loadWithArgv ( $argv)
	Load params and arguments from a given array of command-line arguments.
	memoryLimit ()
	Normally we disable the memory_limit when running admin scripts.
	outputChanneled ( $msg, $channel=null)
	Message outputter with channeled message support.
	purgeRedundantText ( $delete=true)
	Support function for cleaning up redundant text records.
	runChild ( $maintClass, $classFile=null)
	Run a child maintenance script.
	setAgentAndTriggers ()
	This method used to be for internal use by doMaintenance.php to apply some optional global state to LBFactory for debugging purposes.
	setArg ( $argId, $value)
	Programmatically set the value of the given argument.
	setConfig (Config $config)
	setDB (IMaintainableDatabase $db)
	Sets database object to be returned by getDB().
	setName (string $name)
	setOption (string $name, $value)
	Programmatically set the value of the given option.
	setup ()
	Provides subclasses with an opportunity to perform initial checks.
	shutdown ()
	Call before exiting CLI process for the last DB commit, and flush any remaining buffers and other deferred work.
	validateParamsAndArgs ()
	Run some validation checks on the params, etc.

Public Attributes
bool	$compress
	Whether or not to use compression.
IDatabase	$dbr
	A database replica DB object.
resource false	$file
	A resource pointing to a sitemap file.
resource	$findex
	A resource pointing to the sitemap index file.
string	$fspath
	The path to prepend to the filename.
array	$limit = []
	The number of entries to save in each sitemap file.
array	$namespaces = []
	A one-dimensional array of namespaces in the wiki.
array	$priorities = []
	Key => value entries of namespaces and their priorities.
int	$size_limit
	The maximum size of a sitemap file.
bool	$skipRedirects
	Whether or not to include redirection pages.
string	$timestamp
	When this sitemap batch was generated.
int	$url_limit
	The maximum amount of urls in a sitemap file.
string	$urlpath
	The URL path to prepend to filenames in the index; should resolve to the same directory as $fspath.
Public Attributes inherited from Maintenance
resource null	$fileHandle
	Used when creating separate schema files.
array	$orderedOptions = []
	Used to read the options in the order they were passed.
const	DB_ADMIN = 2
const	DB_NONE = 0
	Constants for DB access type.
const	DB_STD = 1
const	GENERIC_MAINTENANCE_PARAMETERS = 'Script runner options'
const	SCRIPT_DEPENDENT_PARAMETERS = 'Common options'
const	STDIN_ALL = -1

Additional Inherited Members
Static Public Member Functions inherited from Maintenance
static	getTermSize ()
	Get the terminal size as a two-element array where the first element is the width (number of columns) and the second element is the height (number of rows).
static	posix_isatty ( $fd)
	Wrapper for posix_isatty() We default as considering stdin a tty (for nice readline methods) but treating stout as not a tty to avoid color codes.
static	readconsole ( $prompt='> ')
	Prompt the console for input.
static	requireTestsAutoloader ()
	Call this to set up the autoloader to allow classes to be used from the tests directory.
static	shouldExecute ()
Protected Member Functions inherited from Maintenance
	addArg ( $arg, $description, $required=true, $multi=false)
	Add some args that are needed.
	addDefaultParams ()
	Add the default parameters to the scripts.
	addDescription ( $text)
	Set the description text.
	addOption ( $name, $description, $required=false, $withArg=false, $shortName=false, $multiOccurrence=false)
	Add a parameter to the script.
	adjustMemoryLimit ()
	Adjusts PHP's memory limit to better suit our needs, if needed.
	afterFinalSetup ()
	Override to perform any required operation at the end of initialisation.
	beginTransaction (IDatabase $dbw, $fname)
	Begin a transaction on a DB.
	commitTransaction (IDatabase $dbw, $fname)
	Commit the transaction on a DB handle and wait for replica DBs to catch up.
	countDown ( $seconds)
	Count down from $seconds to zero on the terminal, with a one-second pause between showing each number.
	deleteOption ( $name)
	Remove an option.
	error ( $err, $die=0)
	Throw an error to the user.
	fatalError ( $msg, $exitCode=1)
	Output a message and terminate the current script.
	getArg ( $argId=0, $default=null)
	Get an argument.
	getBatchSize ()
	Returns batch size.
	getDB ( $db, $groups=[], $dbDomain=false)
	Returns a database to be used by current maintenance script.
	getDir ()
	Get the maintenance directory.
	getHookContainer ()
	Get a HookContainer, for running extension hooks or for hook metadata.
	getHookRunner ()
	Get a HookRunner for running core hooks.
	getOption ( $name, $default=null)
	Get an option, or return the default.
	getStdin ( $len=null)
	Return input from stdin.
	hasArg ( $argId=0)
	Does a given argument exist?
	hasOption ( $name)
	Checks to see if a particular option was set.
	loadSpecialVars ()
	Handle the special variables that are global to all scripts.
	maybeHelp ( $force=false)
	Maybe show the help.
	output ( $out, $channel=null)
	Throw some output to the user.
	parseIntList ( $text)
	Utility function to parse a string (perhaps from a command line option) into a list of integers (perhaps some kind of numeric IDs).
	requireExtension ( $name)
	Indicate that the specified extension must be loaded before the script can run.
	rollbackTransaction (IDatabase $dbw, $fname)
	Rollback the transaction on a DB handle.
	setAllowUnregisteredOptions ( $allow)
	Sets whether to allow unregistered options, which are options passed to a script that do not match an expected parameter.
	setBatchSize ( $s=0)
	showHelp ()
	Definitely show the help.
	supportsOption ( $name)
	Checks to see if a particular option in supported.
	validateUserOption ( $errorMsg)
	waitForReplication ()
	Wait for replica DBs to catch up.
Protected Attributes inherited from Maintenance
array	$mArgList = []
	Empty.
array	$mArgs = []
	This is the list of arguments that were actually passed.
int null	$mBatchSize = null
	Batch size.
	$mDbPass
	$mDbUser
string	$mDescription = ''
	A description of the script, children should change this via addDescription()
bool	$mInputLoaded = false
	Have we already loaded our user input?
array	$mOptions = []
	This is the list of options that were actually passed.
array[]	$mParams = []
	Empty.
bool	$mQuiet = false
	Special vars for params that are always used.
string null	$mSelf
	Name of the script currently running.
MaintenanceParameters	$parameters

Detailed Description

Maintenance script that generates a sitemap for the site.

Definition at line 43 of file generateSitemap.php.

Constructor & Destructor Documentation

__construct()

GenerateSitemap::__construct

(

)

Default constructor.

Children should call this first if implementing their own constructors

Stability: stable

to call

Reimplemented from Maintenance.

Definition at line 150 of file generateSitemap.php.

References Maintenance\addDescription(), and Maintenance\addOption().

Member Function Documentation

execute()

GenerateSitemap::execute

(

)

Execute.

Reimplemented from Maintenance.

Definition at line 184 of file generateSitemap.php.

References $fspath, DB_REPLICA, Maintenance\fatalError(), getDB(), Maintenance\getOption(), Maintenance\hasOption(), main(), wfMkdirParents(), wfTimestamp(), and wfTimestampNow().

main()

GenerateSitemap::main

(

)

Main loop.

Definition at line 339 of file generateSitemap.php.

References $res, $title, Maintenance\output(), and wfTimestamp().

Referenced by execute().

Member Data Documentation

$compress

bool GenerateSitemap::$compress

Whether or not to use compression.

Definition at line 85 of file generateSitemap.php.

$dbr

IDatabase GenerateSitemap::$dbr

A database replica DB object.

Definition at line 127 of file generateSitemap.php.

$file

resource false GenerateSitemap::$file

A resource pointing to a sitemap file.

Definition at line 141 of file generateSitemap.php.

$findex

resource GenerateSitemap::$findex

A resource pointing to the sitemap index file.

Definition at line 134 of file generateSitemap.php.

$fspath

string GenerateSitemap::$fspath

The path to prepend to the filename.

Definition at line 70 of file generateSitemap.php.

Referenced by execute().

$limit

array GenerateSitemap::$limit = []

The number of entries to save in each sitemap file.

Definition at line 99 of file generateSitemap.php.

$namespaces

array GenerateSitemap::$namespaces = []

A one-dimensional array of namespaces in the wiki.

Definition at line 113 of file generateSitemap.php.

$priorities

array GenerateSitemap::$priorities = []

Key => value entries of namespaces and their priorities.

Definition at line 106 of file generateSitemap.php.

$size_limit

int GenerateSitemap::$size_limit

The maximum size of a sitemap file.

http://www.sitemaps.org/faq.php#faq_sitemap_size

Definition at line 63 of file generateSitemap.php.

$skipRedirects

bool GenerateSitemap::$skipRedirects

Whether or not to include redirection pages.

Definition at line 92 of file generateSitemap.php.

$timestamp

string GenerateSitemap::$timestamp

When this sitemap batch was generated.

Definition at line 120 of file generateSitemap.php.

$url_limit

int GenerateSitemap::$url_limit

The maximum amount of urls in a sitemap file.

http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd

Definition at line 54 of file generateSitemap.php.

$urlpath

string GenerateSitemap::$urlpath

The URL path to prepend to filenames in the index; should resolve to the same directory as $fspath.

Definition at line 78 of file generateSitemap.php.

---

The documentation for this class was generated from the following file:

• maintenance/generateSitemap.php