Seed.php

Go to the documentation of this file.

<?php

namespace Elgg\Database\Seeds;

use Elgg\Traits\Cli\Progressing;
use Elgg\Traits\Seeding;

abstract class Seed implements Seedable {

    use Seeding;
    use Progressing {
        advance as private progressAdvance;
    }
    
    protected int $limit;

    protected bool $create = false;
    
    protected int $seeded_counter = 0;
    
    public function __construct(array $options = []) {
        $limit = (int) elgg_extract('limit', $options);
        if ($limit > 0) {
            $this->limit = $limit;
        } else {
            $this->limit = static::getDefaultLimit();
        }
        
        $this->create = (bool) elgg_extract('create', $options, $this->create);
        $this->setCreateSince(elgg_extract('create_since', $options, 'now'));
        $this->setCreateUntil(elgg_extract('create_until', $options, 'now'));
    }
    
    final public static function register(\Elgg\Event $event) {
        $seeds = $event->getValue();
        
        $seeds[] = static::class;
        
        return $seeds;
    }
    
    final public function getCount(): int {
        if ($this->create) {
            return $this->seeded_counter;
        }
        
        $defaults = [
            'metadata_names' => '__faker',
        ];
        $options = array_merge($defaults, $this->getCountOptions());
        
        return elgg_count_entities($options);
    }
    
    public function advance(int $step = 1): void {
        $this->seeded_counter += $step;
        
        $this->progressAdvance($step);
    }
    
    public static function getDefaultLimit(): int {
        return max(elgg_get_config('default_limit'), 20);
    }

    abstract public function seed();

    abstract public function unseed();

    abstract public static function getType(): string;
    
    abstract protected function getCountOptions(): array;
}