abstract class DataUpdate implements DeferrableUpdate {
/** @var mixed Result from LBFactory::getEmptyTransactionTicket() */
protected $ticket;
+ /** @var string Short update cause action description */
+ protected $causeAction = 'unknown';
+ /** @var string Short update cause user description */
+ protected $causeAgent = 'unknown';
public function __construct() {
// noop
}
/**
- * Convenience method, calls doUpdate() on every DataUpdate in the array.
- *
- * This methods supports transactions logic by first calling beginTransaction()
- * on all updates in the array, then calling doUpdate() on each, and, if all goes well,
- * then calling commitTransaction() on each update. If an error occurs,
- * rollbackTransaction() will be called on any update object that had beginTransaction()
- * called but not yet commitTransaction().
- *
- * This allows for limited transactional logic across multiple backends for storing
- * secondary data.
- *
- * @param DataUpdate[] $updates A list of DataUpdate instances
- * @param string $mode Use "enqueue" to use the job queue when possible [Default: run]
- * @throws Exception|null
+ * @param string $action Action type
+ * @param string $user User name
*/
- public static function runUpdates( array $updates, $mode = 'run' ) {
- if ( $mode === 'enqueue' ) {
- // When possible, push updates as jobs instead of calling doUpdate()
- $updates = self::enqueueUpdates( $updates );
- }
+ public function setCause( $action, $user ) {
+ $this->causeAction = $action;
+ $this->causeAgent = $user;
+ }
- foreach ( $updates as $update ) {
- $update->doUpdate();
- }
+ /**
+ * @return string
+ */
+ public function getCauseAction() {
+ return $this->causeAction;
+ }
+
+ /**
+ * @return string
+ */
+ public function getCauseAgent() {
+ return $this->causeAgent;
}
/**
- * Enqueue jobs for every DataUpdate that support enqueueUpdate()
- * and return the remaining DataUpdate objects (those that do not)
+ * Convenience method, calls doUpdate() on every DataUpdate in the array.
*
* @param DataUpdate[] $updates A list of DataUpdate instances
- * @return DataUpdate[]
- * @since 1.27
+ * @throws Exception
+ * @deprecated Since 1.28 Use DeferredUpdates::execute()
*/
- protected static function enqueueUpdates( array $updates ) {
- $remaining = [];
-
+ public static function runUpdates( array $updates ) {
foreach ( $updates as $update ) {
- if ( $update instanceof EnqueueableDataUpdate ) {
- $spec = $update->getAsJobSpecification();
- JobQueueGroup::singleton( $spec['wiki'] )->push( $spec['job'] );
- } else {
- $remaining[] = $update;
- }
+ $update->doUpdate();
}
-
- return $remaining;
}
}