MediaWiki REL1_27
GenerateNormalizerDataAr Class Reference

Generates the normalizer data file for Arabic. More...

Inheritance diagram for GenerateNormalizerDataAr:
Collaboration diagram for GenerateNormalizerDataAr:

Public Member Functions

 __construct ()
 Default constructor.
 
 execute ()
 Do the actual work.
 
 getDbType ()
 Does the script need different DB access? By default, we give Maintenance scripts normal rights to the DB.
 
- Public Member Functions inherited from Maintenance
function __construct ()
 
 cleanupChanneled ()
 Clean up channeled output.
 
 clearParamsAndArgs ()
 Clear all params and arguments.
 
function execute ()
 
 finalSetup ()
 Handle some last-minute setup here.
 
 getConfig ()
 
 getName ()
 Get the script's name.
 
 globals ()
 Potentially debug globals.
 
 isQuiet ()
 
 loadParamsAndArgs ( $self=null, $opts=null, $args=null)
 Process command line arguments $mOptions becomes an array with keys set to the option names $mArgs becomes a zero-based array containing the non-option arguments.
 
 loadSettings ()
 Generic setup for most installs.
 
 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.
 
 setConfig (Config $config)
 
 setDB (IDatabase $db)
 Sets database object to be returned by getDB().
 
 setup ()
 Do some sanity checking and basic setup.
 
 updateSearchIndex ( $maxLockTime, $callback, $dbw, $results)
 Perform a search index update with locking.
 
 updateSearchIndexForPage ( $dbw, $pageId)
 Update the searchindex table for a given pageid.
 

Additional Inherited Members

- Static Public Member Functions inherited from Maintenance
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 shouldExecute ()
 Should we execute the maintenance script, or just allow it to be included as a standalone class? It checks that the call stack only includes this function and "requires" (meaning was called from the file scope)
 
- Public Attributes inherited from Maintenance
resource $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 STDIN_ALL = 'all'
 
- Protected Member Functions inherited from Maintenance
 activateProfiler ()
 Activate the profiler (assuming $wgProfiler is set)
 
 addArg ( $arg, $description, $required=true)
 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 ()
 Execute a callback function at the end of initialisation.
 
 beginTransaction (IDatabase $dbw, $fname)
 Begin a transcation on a DB.
 
 commitTransaction (IDatabase $dbw, $fname)
 Commit the transcation on a DB handle and wait for slaves to catch up.
 
 deleteOption ( $name)
 Remove an option.
 
 error ( $err, $die=0)
 Throw an error to the user.
 
 getArg ( $argId=0, $default=null)
 Get an argument.
 
 getDB ( $db, $groups=[], $wiki=false)
 Returns a database to be used by current maintenance script.
 
 getDir ()
 Get the maintenance directory.
 
 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 param exists.
 
 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.
 
 rollbackTransaction (IDatabase $dbw, $fname)
 Rollback the transcation on a DB handle.
 
 setBatchSize ( $s=0)
 Set the batch size.
 
 validateParamsAndArgs ()
 Run some validation checks on the params, etc.
 
- Protected Attributes inherited from Maintenance
 $mArgList = []
 
 $mArgs = []
 
int $mBatchSize = null
 Batch size.
 
 $mDbPass
 
 $mDbUser
 
 $mDescription = ''
 
 $mInputLoaded = false
 
 $mOptions = []
 
 $mParams = []
 
 $mQuiet = false
 
 $mSelf
 
 $mShortParamsMap = []
 

Detailed Description

Generates the normalizer data file for Arabic.

This data file is used after normalizing to NFC.

Definition at line 33 of file generateNormalizerDataAr.php.

Constructor & Destructor Documentation

◆ __construct()

GenerateNormalizerDataAr::__construct ( )

Default constructor.

Children should call this first if implementing their own constructors

Reimplemented from Maintenance.

Definition at line 34 of file generateNormalizerDataAr.php.

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

Member Function Documentation

◆ execute()

GenerateNormalizerDataAr::execute ( )

Do the actual work.

All child classes will need to implement this

Reimplemented from Maintenance.

Definition at line 45 of file generateNormalizerDataAr.php.

References $code, $IP, $line, $name, $source, as, Maintenance\error(), Maintenance\getOption(), global, Maintenance\hasOption(), and serialize().

◆ getDbType()

GenerateNormalizerDataAr::getDbType ( )

Does the script need different DB access? By default, we give Maintenance scripts normal rights to the DB.

Sometimes, a script needs admin rights access for a reason and sometimes they want no access. Subclasses should override and return one of the following values, as needed: Maintenance::DB_NONE - For no DB access at all Maintenance::DB_STD - For normal DB access, default Maintenance::DB_ADMIN - For admin DB access

Returns
int

Reimplemented from Maintenance.

Definition at line 41 of file generateNormalizerDataAr.php.

References Maintenance\DB_NONE.


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