MediaWiki master
CategoryChangesAsRdf Class Reference

Maintenance script to provide RDF representation of the recent changes in category tree. More...

Inherits Maintenance.

Collaboration diagram for CategoryChangesAsRdf:

Public Member Functions

 __construct ()
 Default constructor.
 
 execute ()
 Do the actual work.
 
 getRdf ()
 Get accumulated RDF.
 
 handleAdds (IReadableDatabase $dbr, $output)
 
 handleCategorization (IReadableDatabase $dbr, $output)
 Handles categorization changes.
 
 handleDeletes (IReadableDatabase $dbr, $output)
 Handle category deletes.
 
 handleEdits (IReadableDatabase $dbr, $output)
 Handle edits for category texts.
 
 handleMoves (IReadableDatabase $dbr, $output)
 
 handleRestores (IReadableDatabase $dbr, $output)
 
 initialize ()
 Initialize external service classes.
 
 updateTS ( $timestamp)
 Generate SPARQL Update code for updating dump timestamp.
 
- 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)
 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 ()
 
 isQuiet ()
 
 loadParamsAndArgs ( $self=null, $opts=null, $args=null)
 Process command line arguments when running as a child script.
 
 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.
 
 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().
 
 setDBProvider (IConnectionProvider $dbProvider)
 
 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.
 
 validateParamsAndArgs ()
 Run some validation checks on the params, etc.
 

Protected Member Functions

 getCategoryLinksIterator (IReadableDatabase $dbr, array $ids, $fname)
 Get iterator for links for categories.
 
 getChangedCatsIterator (IReadableDatabase $dbr, $type, $fname)
 Fetch categorization changes or edits.
 
 getDeletedCatsIterator (IReadableDatabase $dbr, $fname)
 Fetch deleted categories.
 
 getMovedCatsIterator (IReadableDatabase $dbr, $fname)
 Fetch moved categories.
 
 getNewCatsIterator (IReadableDatabase $dbr, $fname)
 Fetch newly created categories.
 
 getRestoredCatsIterator (IReadableDatabase $dbr, $fname)
 Fetch restored categories.
 
- 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.
 
 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.
 
 getArgs ( $offset=0)
 Get arguments.
 
 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.
 
 getPrimaryDB ()
 
 getReplicaDB ()
 
 getServiceContainer ()
 Returns the main service container.
 
 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

true[] $processed = []
 List of processed page IDs, so we don't try to process same thing twice.
 
- Protected Attributes inherited from Maintenance
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
 

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.
 
- 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
 

Detailed Description

Maintenance script to provide RDF representation of the recent changes in category tree.

Since
1.30

Definition at line 35 of file categoryChangesAsRdf.php.

Constructor & Destructor Documentation

◆ __construct()

CategoryChangesAsRdf::__construct ( )

Default constructor.

Children should call this first if implementing their own constructors

Stability: stable
to call

Reimplemented from Maintenance.

Definition at line 81 of file categoryChangesAsRdf.php.

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

Member Function Documentation

◆ execute()

CategoryChangesAsRdf::execute ( )

Do the actual work.

All child classes will need to implement this

Returns
bool|null|void True for success, false for failure. Not returning a value, or returning null, is also interpreted as success. Returning false for failure will cause doMaintenance.php to exit the process with a non-zero exit status.

Reimplemented from Maintenance.

Definition at line 104 of file categoryChangesAsRdf.php.

References DB_REPLICA, Maintenance\error(), Maintenance\getConfig(), getDB(), Maintenance\getOption(), getRdf(), handleAdds(), handleCategorization(), handleDeletes(), handleEdits(), handleMoves(), handleRestores(), initialize(), and updateTS().

◆ getCategoryLinksIterator()

CategoryChangesAsRdf::getCategoryLinksIterator ( IReadableDatabase  $dbr,
array  $ids,
  $fname 
)
protected

Get iterator for links for categories.

Parameters
IReadableDatabase$dbr
int[]$idsList of page IDs
string$fnameName of the calling function
Returns
Traversable

Definition at line 411 of file categoryChangesAsRdf.php.

References BatchRowIterator\addConditions(), BatchRowIterator\setCaller(), and BatchRowIterator\setFetchColumns().

◆ getChangedCatsIterator()

CategoryChangesAsRdf::getChangedCatsIterator ( IReadableDatabase  $dbr,
  $type,
  $fname 
)
protected

Fetch categorization changes or edits.

Parameters
IReadableDatabase$dbr
int$type
string$fnameName of the calling function
Returns
BatchRowIterator

Definition at line 371 of file categoryChangesAsRdf.php.

References NS_CATEGORY.

Referenced by handleCategorization(), and handleEdits().

◆ getDeletedCatsIterator()

CategoryChangesAsRdf::getDeletedCatsIterator ( IReadableDatabase  $dbr,
  $fname 
)
protected

Fetch deleted categories.

Parameters
IReadableDatabase$dbr
string$fnameName of the calling function
Returns
BatchRowIterator

Definition at line 320 of file categoryChangesAsRdf.php.

References NS_CATEGORY, and RC_LOG.

Referenced by handleDeletes().

◆ getMovedCatsIterator()

CategoryChangesAsRdf::getMovedCatsIterator ( IReadableDatabase  $dbr,
  $fname 
)
protected

Fetch moved categories.

Parameters
IReadableDatabase$dbr
string$fnameName of the calling function
Returns
BatchRowIterator

Definition at line 294 of file categoryChangesAsRdf.php.

References NS_CATEGORY, and RC_LOG.

Referenced by handleMoves().

◆ getNewCatsIterator()

CategoryChangesAsRdf::getNewCatsIterator ( IReadableDatabase  $dbr,
  $fname 
)
protected

Fetch newly created categories.

Parameters
IReadableDatabase$dbr
string$fnameName of the calling function
Returns
BatchRowIterator

Definition at line 279 of file categoryChangesAsRdf.php.

References NS_CATEGORY.

Referenced by handleAdds().

◆ getRdf()

CategoryChangesAsRdf::getRdf ( )

Get accumulated RDF.

Returns
string

Definition at line 431 of file categoryChangesAsRdf.php.

Referenced by execute().

◆ getRestoredCatsIterator()

CategoryChangesAsRdf::getRestoredCatsIterator ( IReadableDatabase  $dbr,
  $fname 
)
protected

Fetch restored categories.

Parameters
IReadableDatabase$dbr
string$fnameName of the calling function
Returns
BatchRowIterator

Definition at line 349 of file categoryChangesAsRdf.php.

References NS_CATEGORY, and RC_LOG.

Referenced by handleRestores().

◆ handleAdds()

CategoryChangesAsRdf::handleAdds ( IReadableDatabase  $dbr,
  $output 
)
Parameters
IReadableDatabase$dbr
resource$output

Definition at line 531 of file categoryChangesAsRdf.php.

References getNewCatsIterator().

Referenced by execute().

◆ handleCategorization()

CategoryChangesAsRdf::handleCategorization ( IReadableDatabase  $dbr,
  $output 
)

Handles categorization changes.

Parameters
IReadableDatabase$dbr
resource$output

Definition at line 591 of file categoryChangesAsRdf.php.

References getChangedCatsIterator(), Wikimedia\Rdbms\IReadableDatabase\newSelectQueryBuilder(), NS_CATEGORY, and RC_CATEGORIZE.

Referenced by execute().

◆ handleDeletes()

CategoryChangesAsRdf::handleDeletes ( IReadableDatabase  $dbr,
  $output 
)

Handle category deletes.

Parameters
IReadableDatabase$dbr
resource$outputFile to write the output

Definition at line 440 of file categoryChangesAsRdf.php.

References getDeletedCatsIterator().

Referenced by execute().

◆ handleEdits()

CategoryChangesAsRdf::handleEdits ( IReadableDatabase  $dbr,
  $output 
)

Handle edits for category texts.

Parameters
IReadableDatabase$dbr
resource$output

Definition at line 560 of file categoryChangesAsRdf.php.

References getChangedCatsIterator(), and RC_EDIT.

Referenced by execute().

◆ handleMoves()

CategoryChangesAsRdf::handleMoves ( IReadableDatabase  $dbr,
  $output 
)
Parameters
IReadableDatabase$dbr
resource$output

Definition at line 471 of file categoryChangesAsRdf.php.

References getMovedCatsIterator(), and NS_CATEGORY.

Referenced by execute().

◆ handleRestores()

CategoryChangesAsRdf::handleRestores ( IReadableDatabase  $dbr,
  $output 
)
Parameters
IReadableDatabase$dbr
resource$output

Definition at line 501 of file categoryChangesAsRdf.php.

References getRestoredCatsIterator().

Referenced by execute().

◆ initialize()

CategoryChangesAsRdf::initialize ( )

Initialize external service classes.

Definition at line 98 of file categoryChangesAsRdf.php.

Referenced by execute().

◆ updateTS()

CategoryChangesAsRdf::updateTS (   $timestamp)

Generate SPARQL Update code for updating dump timestamp.

Parameters
string | int$timestampTimestamp for last change
Returns
string SPARQL Update query for timestamp.

Definition at line 209 of file categoryChangesAsRdf.php.

References wfTimestamp().

Referenced by execute().

Member Data Documentation

◆ $processed

true [] CategoryChangesAsRdf::$processed = []
protected

List of processed page IDs, so we don't try to process same thing twice.

Definition at line 79 of file categoryChangesAsRdf.php.


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