RemoveIcontime.php

Go to the documentation of this file.

<?php

namespace Elgg\Upgrades;

use Elgg\Upgrade\Result;
use Elgg\Upgrade\SystemUpgrade;

class RemoveIcontime extends SystemUpgrade {
    
    public function getVersion(): int {
        return 2024020901;
    }
    
    public function shouldBeSkipped(): bool {
        return empty($this->countItems());
    }
    
    public function needsIncrementOffset(): bool {
        return false;
    }
    
    public function countItems(): int {
        return elgg_get_metadata($this->getOptions([
            'count' => true,
        ]));
    }
    
    public function run(Result $result, $offset): Result {
        /* @var $metadata \ElggBatch */
        $metadata = elgg_get_metadata($this->getOptions([
            'offset' => $offset,
        ]));
        
        /* @var $md \ElggMetadata */
        foreach ($metadata as $md) {
            if (!$md->delete()) {
                $metadata->reportFailure();
                $result->addFailures();
                continue;
            }
            
            $result->addSuccesses();
        }
        
        return $result;
    }
    
    protected function getOptions(array $options = []): array {
        $defaults = [
            'metadata_names' => 'icontime',
            'limit' => 50,
            'batch' => true,
            'batch_inc_offset' => $this->needsIncrementOffset(),
        ];
        
        return array_merge($defaults, $options);
    }
}