PinkCrab\Perique\Migration\Migration

Complexity

Total Complexity

4

Size/Duplication

Total Lines	49
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	drop_on_deactivation()	0	2	1
A	drop_on_uninstall()	0	2	1
A	__construct()	0	4	1
A	seed_on_inital_activation()	0	2	1

<?php

declare(strict_types=1);

/**
 * Abstract class for all Migrations
 *
 * @package PinkCrab\Perique\Migration\Plugin_Lifecycle
 * @author Glynn Quelch glynn@pinkcrab.co.uk
 * @since 0.0.1
 */

namespace PinkCrab\Perique\Migration;

use PinkCrab\DB_Migration\Database_Migration;
use PinkCrab\Table_Builder\Schema;

/**
 * Abstract class for all Migrations
 *
 * @method void schema(\PinkCrab\Table_Builder\Schema $schema)
 */
abstract class Migration extends Database_Migration {

	/**
	 * Creates an instance of the migration.
	 */
	public function __construct() {
		$this->table_name = $this->table_name();
		$this->schema     = new Schema( $this->table_name, array( $this, 'schema' ) );
		$this->seed_data  = $this->seed( array() );
	}

	/**
	 * Must return the table name for the migration.
	 *
	 * @return string
	 */
	abstract protected function table_name(): string;

	/**
	 * Is this table dropped on deactivation
	 *
	 * Defaults to false.
	 *
	 * @return bool
	 */
	public function drop_on_deactivation(): bool {
		return false;
	}

	/**
	 * Drop table on uninstall.
	 *
	 * Defaults to false.
	 *
	 * @return bool
	 */
	public function drop_on_uninstall(): bool {
		return false;
	}

	/**
	 * Should this migration be seeded on activation.
	 *
	 * Defaults to true.
	 *
	 * @return bool
	 */
	public function seed_on_inital_activation(): bool {
		return true;
	}
}