NullJob Class Reference
Degenerate job that does nothing, but can optionally replace itself in the queue and/or sleep for a brief time period. More...
Inheritance diagram for NullJob:
Collaboration diagram for NullJob:
Public Member Functions | |
| __construct (Title $title, array $params) | |
| run () | |
| Run the job. | |
 Public Member Functions inherited from Job | |
| __construct ( $command, $params=null) | |
| allowRetries () | |
| getDeduplicationInfo () | |
| Subclasses may need to override this to make duplication detection work. | |
| getLastError () | |
| getMetadata ( $field=null) | |
| getParams () | |
| getQueuedTimestamp () | |
| getReadyTimestamp () | |
| getReleaseTimestamp () | |
| getRequestId () | |
| getRootJobParams () | |
| getTitle () | |
| getType () | |
| hasExecutionFlag ( $flag) | |
| hasRootJobParams () | |
| ignoreDuplicates () | |
| Whether the queue should reject insertion of this job if a duplicate exists. | |
| isRootJob () | |
| setMetadata ( $field, $value) | |
| teardown ( $status) | |
| Do any final cleanup after run(), deferred updates, and all DB commits happen. | |
| toString () | |
| workItemCount () | |
Additional Inherited Members | |
| Static Public Member Functions inherited from Job | |
| static | factory ( $command, $params=[]) |
| Create the appropriate object to handle a specific job. | |
| static | newRootJobParams ( $key) |
| Get "root job" parameters for a task. | |
| Public Attributes inherited from Job | |
| string | $command |
| array | $metadata = [] |
| Additional queue metadata. | |
| array | $params |
| Array of job parameters. | |
| Protected Member Functions inherited from Job | |
| addTeardownCallback ( $callback) | |
| setLastError ( $error) | |
| Protected Attributes inherited from Job | |
| string | $error |
| Text for error that occurred last. | |
| int | $executionFlags = 0 |
| Bitfield of JOB_* class constants. | |
| bool | $removeDuplicates = false |
| Expensive jobs may set this to true. | |
| callable[] | $teardownCallbacks = [] |
| Title | $title |
Detailed Description
Degenerate job that does nothing, but can optionally replace itself in the queue and/or sleep for a brief time period.
These can be used to represent "no-op" jobs or test lock contention and performance.
- Example:
- Inserting a null job in the configured job queue: You can then confirm the job has been enqueued by using the showJobs.php maintenance utility:$ php maintenance/eval.php> $queue = JobQueueGroup::singleton();Degenerate job that does nothing, but can optionally replace itself in the queue and/or sleep for a b...Definition NullJob.php:47$ php maintenance/showJobs.php --groupnull: 1 queue; 0 claimed (0 active, 0 abandoned)$and that you know you can do these things To protect your we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights These restrictions translate to certain responsibilities for you if you distribute copies of the or if you modify it For if you distribute copies of such a whether gratis or for a you must give the recipients all the rights that you have You must make sure that receive or can get the source code And you must show them these terms so they know their rights We protect your rights with two and(2) offer you this license which gives you legal permission to copyinvalid e g too many</span ></p > !end !test with< references/> in group !wikitext Wikipedia rocks< ref > Proceeds of vol XXI</ref > Wikipedia rocks< ref group="note"> Proceeds of vol XXI</ref >< references/>< references group="note"/> ! html< p > Wikipedia rocks< sup id="cite_ref-1" class="reference">< a href="#cite_note-1"> &Wikipedia rocks< sup id="cite_ref-2" class="reference">< a href="#cite_note-2"> &</p >< div class="mw-references-wrap">< ol class="references">< li id="cite_note-1">< span class="mw-cite-backlink">< a href="#cite_ref-1"> ↑</a ></span >< span class="reference-text"> Proceeds of vol XXI</span ></li ></ol ></div >< div class="mw-references-wrap">< ol class="references">< li id="cite_note-2">< span class="mw-cite-backlink">< a href="#cite_ref-2"> ↑</a ></span >< span class="reference-text"> Proceeds of vol XXI</span ></li ></ol ></div > !end !test with< references/> in groupDefinition citeParserTests.txt:376
Definition at line 47 of file NullJob.php.
Constructor & Destructor Documentation
◆ __construct()
Definition at line 52 of file NullJob.php.
References Job\$params, and and().
Member Function Documentation
◆ run()
| NullJob::run | ( | ) |
Run the job.
- Returns
- bool Success
Reimplemented from Job.
Definition at line 63 of file NullJob.php.
References $job, Job\$params, Job\$title, and and().
The documentation for this class was generated from the following file:
- includes/jobqueue/jobs/NullJob.php
