File batch/job.php

  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234

<?php

namespace SIW\Batch;

use SIW\Scheduler;
use SIW\Admin\Admin_Bar;

/**
 * Uitbreiding van WP_Background_Process
 * 
 * - Logging
 * - Aantal verwerkte items bijhouden
 * - Toevoegen aan admin bar
 * - Schedulen
 * 
 * @copyright 2019 SIW Internationale Vrijwilligersprojecten
 * @since     3.0.0
 */
abstract class Job extends \WP_Background_Process {
    
    /**
     * Prefix
     * 
     * @var string
     */
    protected $prefix = 'siw';

    /**
     * Optie voor logger-context
     *
     * @var string
     */
    protected $logger_context_option;

    /**
     * Optie voor teller verwerkte items
     *
     * @var string
     */
    protected $processed_count_option;

    /**
     * Naam van proces (voor logging en admin bar)
     *
     * @var string
     */
    protected $name;

    /**
     * Category (voor admin bar)
     *
     * @var string
     */
    protected $category;

    /**
     * Grootte van batch
     * 
     * @var int
     */
    protected $batch_size = 500;

    /**
     * Geeft aan of deze batch job ingepland moet worden
     *
     * @var bool
     */
    protected $schedule_job = true;

    /**
     * Initiate new background process
     */
    public function __construct() {
        parent::__construct();
        $this->logger_context_option = $this->identifier . '_logger_context';
        $this->processed_count_option = $this->identifier . '_processed_count';
    }

    /**
     * Init
     */
    public static function init() {
        $self = new static();
        add_action( "siw_{$self->action}", [ $self, 'start'] );

        Admin_Bar::add_node(
            sanitize_title( $self->category ),
            [
                'title' => ucfirst( $self->category ) ]
        );

        Admin_Bar::add_action(
            $self->action,
            [ 
                'parent' => sanitize_title( $self->category ),
                'title'  => ucfirst( $self->name ),
            ]
        );
        
        if ( $self->schedule_job ) {
            Scheduler::add_job( "siw_{$self->action}" );
        }
    }

    /**
     * Leeg de queue
     */
    protected function empty_queue() {
        $this->data = [];
    }

    /**
     * Zet logger-context in optie
     *
     * @param array $context
     */
    public function set_logger_context() {
        $source = sanitize_title( "siw-{$this->name}" );
        $context = [ 'source' => $source ];
        update_site_option( $this->logger_context_option, $context );
    }
    
    /**
     * Haal logger-context op
     *
     * @return array
     */
    protected function get_logger_context() {
        $logger_context = get_site_option( $this->logger_context_option );
        return $logger_context;
    }

    /**
     * Verwijder opties
     */
    protected function cleanup() {
        delete_site_option( $this->logger_context_option );
        delete_site_option( $this->processed_count_option );
    }

    /**
     * Schrijf boodschap naar log
     *
     * @param string $level
     * @param string $message
     */
    protected function log( $level, $message ) {
        $logger = wc_get_logger();
        $context = $this->get_logger_context();
        $logger->log( $level, $message, $context );
    }

    /**
     * Zet het aantal verwerkte items
     *
     * @param int $processed_count
     */
    protected function set_processed_count( $processed_count ) {
        update_site_option( $this->processed_count_option, $processed_count );
    }

    /**
     * Haal aantal verwerkte items op
     *
     * @return int
     */
    protected function get_processed_count() {
        $processed_count = get_site_option( $this->processed_count_option );
        return $processed_count;
    }

    /**
     * Hoog aantal verwerkte items met 1 op
     */
    protected function increment_processed_count() {
        $processed_count = $this->get_processed_count();
        $processed_count++;
        $this->set_processed_count( $processed_count );
    }

    /**
     * Functie om te verwerken data te selecteren.
     *
     * @return array
     */
    protected abstract function select_data();

    /**
     * Starten achtergrondproces
     *
     * - Logger
     * - Aantal verwerkte items
     * - Gegevens ophalen
     */
    public function start() {
 
        $this->set_logger_context();
        $this->set_processed_count( 0 );
        $this->log( 'info', sprintf( 'Start %s', $this->name ) );

        /* Te verwerken items ophalen */
        $data = $this->select_data();

        /* Afbreken als er geen items te verwerken zijn */
        if ( empty( $data ) ) {
            $this->log('info', sprintf( 'Eind %s, geen items te verwerken', $this->name ) );
            $this->cleanup();
            return;
        }

        /* Data opdelen in batches */
        $batches = array_chunk( $data, $this->batch_size );
        foreach ( $batches as $batch ) {
            foreach ( $batch as $item ) {
                $this->push_to_queue( $item );
            }
            $this->save();
            $this->empty_queue();
        }

        /* Start proces */
        $this->dispatch();
    }

    /**
     * Afronden
     */
    protected function complete() {
        parent::complete();
        $this->log( 'info', sprintf( 'Eind %s, %s items verwerkt', $this->name, $this->get_processed_count() ) );
        $this->cleanup();
    }
}

Namespaces

Classes

Functions