SMWRefreshJob Class Reference
[Semantic MediaWiki]

SMWRefreshJob iterates over all page ids of the wiki, to perform an update action for all of them in sequence. More...

List of all members.

Public Member Functions
	__construct ($title, $params=array( 'spos'=> 1, 'prog'=> 0, 'rc'=> 1))
	Constructor.
	run ()
	Run job.
	getProgress ()
	Report the estimated progress status of this job as a number between 0 and 1 (0% to 100%).

---

Detailed Description

SMWRefreshJob iterates over all page ids of the wiki, to perform an update action for all of them in sequence.

This corresponds to the in-wiki version of the SMW_refreshData.php script for updating the whole wiki, but it also fixes problems with SMWSQLStore2 (which may have objects in its database that are not proper wiki pages).

Note:

This class ignores $smwgEnableUpdateJobs and always creates updates. In fact, it might be needed specifically on wikis that do not use update jobs in normal operation.

Author:

Markus Krötzsch

Definition at line 21 of file SMW_RefreshJob.php.

---

Constructor & Destructor Documentation

SMWRefreshJob::__construct	(	$	title,
		$	params = array( 'spos' => 1, 'prog' => 0, 'rc' => 1 )
	)

Constructor.

The parameters optionally specified in the second argument of this constructor use the following array keys: 'spos' (start index, default 1), 'prog' (progress indicator, default 0), ('rc' (number of runs to be done, default 1). If more than one run is done, then the first run will restrict to properties and types. The progress indication refers to the current run, not to the overall job.

Parameters:

	$title	Title not relevant but needed for MW jobs
	$params	array (associative) as explained above

Definition at line 35 of file SMW_RefreshJob.php.

---

Member Function Documentation

SMWRefreshJob::run

(

)

Run job.

Returns:

boolean success

Definition at line 44 of file SMW_RefreshJob.php.

References smwfGetStore().

SMWRefreshJob::getProgress

(

)

Report the estimated progress status of this job as a number between 0 and 1 (0% to 100%).

The progress refers to the state before processing this job.

Returns:

double

Definition at line 77 of file SMW_RefreshJob.php.

---

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

• SemanticMediaWiki/includes/jobs/SMW_RefreshJob.php